10.2.5: AGSTiledLayer Class Reference
10.2.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
AGSTiledLayer Class Reference

Description

A base class for layers which displays cached maps. You would typically work with one or more sub-classes of this class, for instance, AGSTiledMapServiceLayer.

Defined in:
AGSTiledLayer.h (ArcGIS library)

Since
1.0
Inheritance diagram for AGSTiledLayer:
AGSLayer AGSLocalTiledLayer AGSTiledServiceLayer AGSBingMapLayer AGSOpenStreetMapLayer AGSTiledMapServiceLayer AGSWebTiledLayer AGSWMTSLayer

Instance Methods

(void) - cancelRequestForKey:
 
(double) - convertedResolutionForLodResolution:
 
(double) - convertedScaleForLodScale:
 
(AGSLOD *) - currentLOD
 
(int) - defaultDpi
 
(BOOL) - isInScale
 
(void) - layerDidFailToLoad:
 
(void) - layerDidLoad
 
(void) - mapDidUpdate:
 
(void) - refresh
 
(void) - requestTileForKey:
 
(void) - setTileData:forKey:
 
(void) - spatialReferenceStatusInitialized
 

Properties

CGFloat brightness
 
CGFloat bufferFactor
 
CGFloat contrast
 
id< AGSLayerDelegatedelegate
 
NSError * error
 
AGSEnvelopefullEnvelope
 
CGFloat gamma
 
AGSEnvelopeinitialEnvelope
 
BOOL loaded
 
AGSMapViewmapView
 
double maxScale
 
double minScale
 
NSString * name
 
CGFloat opacity
 
BOOL renderNativeResolution
 
AGSSpatialReferencespatialReference
 
BOOL spatialReferenceStatusValid
 
AGSTileInfotileInfo
 
BOOL timeAware
 
BOOL visible
 

Method Documentation

- (void) cancelRequestForKey: (AGSTileKey *)  key

This must be implemented by subclasses to cancel previous tile requests. It will be called by the framework when a tile request needs to be aborted.

Since
10.1.1

Provided by category AGSTiledLayer(ForSubclassEyesOnly).

- (double) convertedResolutionForLodResolution: (double)  lodResolution

Takes the resolution passed in and converts it to a resolution you can zoom to on the map to see the tiles for that particular LOD. This takes into account how the layer is being rendered on the map and the PPI of the device the map is on.

Parameters
lodResolutionThe resolution reported by an AGSLOD object
Returns
equivalent map resolution that you can zoom to
Since
10.1.1
- (double) convertedScaleForLodScale: (double)  lodScale

Takes the scale passed in and converts it to a scale you can zoom to on the map to see the tiles for that particular LOD. This takes into account how the layer is being rendered on the map and the PPI of the device the map is on.

Parameters
lodScaleThe scale reported by an AGSLOD object
Returns
equivalent map scale that you can zoom to
Since
10.1.1
- (AGSLOD*) currentLOD

The current LOD that is being displayed on the map for this layer. If the layer is not in a map it will return nil.

Since
10.2.2
- (int) defaultDpi

The default dpi for the layer.

Since
10.1.1

Provided by category AGSLayer(ForSubclassEyesOnly).

- (BOOL) isInScale

Indicates whether the map's scale is within this layer's scale range (minScale and maxScale).

Since
10.1.1
- (void) layerDidFailToLoad: (NSError *)  error

Subclasses should call this when the layer fails to load. Implementation for this method is provided by the framework.

Since
10.1.1

Provided by category AGSLayer(ForSubclassEyesOnly).

- (void) layerDidLoad

Subclasses should call this when the layer is ready to draw. Implementation for this method is provided by the framework.

Since
10.1.1

Provided by category AGSLayer(ForSubclassEyesOnly).

- (void) mapDidUpdate: (AGSMapUpdateType updateType

Method called when the map is updated. You can override this, but make sure to call the super's implementation.

Since
10.1.1

Provided by category AGSLayer(ForSubclassEyesOnly).

- (void) refresh

This method tells the layer that it should refresh its data and redraw.

Since
10.1.1

Implemented in AGSFeatureLayer, and AGSGraphicsLayer.

- (void) requestTileForKey: (AGSTileKey *)  key

This must be implemented by subclasses to retreive the requested tile. It will be called by the framework when a tile is needed.

Since
10.1.1

Provided by category AGSTiledLayer(ForSubclassEyesOnly).

- (void) setTileData: (NSData *)  data
forKey: (AGSTileKey *)  tilekey 

Subclasses should call this when they have the data for a previously requested tile. If subclasses failed to fetch a tile or encountered some other error, they should pass nil. The implementation for this method is provided by the framework.

Since
10.1.1

Provided by category AGSTiledLayer(ForSubclassEyesOnly).

- (void) spatialReferenceStatusInitialized

Called when the status of the layer's spatial reference has been established. You can override this method, just make sure to call the super's implementation.

Since
10.1.1

Provided by category AGSLayer(ForSubclassEyesOnly).

Property Documentation

- (CGFloat) brightness
readwritenonatomicassign

The brightness of the layer. Default value is 0. Values in the range -100.0 to 100.0 are valid. Values outside that range are ignored.

Since
10.2.3
- (CGFloat) bufferFactor
readwritenonatomicassign

Percentage of map's extent by which a buffer of tiles will be fetched. A value of 1.0 corresponds to the actual visible extent. A value of 1.2 for example will increase the visible extent by 20 percents. The expansion factor will determine eventually how many additional rows an columns of tiles the layer will fetch/render in addition to those covering the visible extent. Setting this value too high will have a negative impact on performance because the more tiles that are fetched, the more memory is used.

Default value is 1. Values in the range 1 - 2 are valid. Values below 1 and above 2 are ignored.

Since
10.2.2
- (CGFloat) contrast
readwritenonatomicassign

The contrast of the layer. Default value is 0. Values in the range -100.0 to 100.0 are valid. Values outside that range are ignored.

Since
10.2.3
- (id<AGSLayerDelegate>) delegate
readwritenonatomicweakinherited

Delegate to be notified when the layer is loaded or fails to load.

Since
1.0
- (NSError*) error
readnonatomicstronginherited

Information about the error associated with a layer.

Since
1.0

Provided by category AGSLayer(ForSubclassEyesOnly).

- (AGSEnvelope*) fullEnvelope
readnonatomicstronginherited

Full extent of the layer.

Since
1.0
- (CGFloat) gamma
readwritenonatomicassign

The gamma of the layer. Default value is 0. Values in the range -100.0 to 100.0 are valid. Values outside that range are ignored.

Since
10.2.3
- (AGSEnvelope*) initialEnvelope
readwritenonatomicstronginherited

Gets or sets the initial envelope of the layer.

Since
1.0
- (BOOL) loaded
readnonatomicassigninherited

Indicates that this layer loaded successfully.

Since
1.0
- (AGSMapView*) mapView
readwritenonatomicweakinherited

The map that the layer is in.

Since
10.1.1

Provided by category AGSLayer(ForSubclassEyesOnly).

- (double) maxScale
readwritenonatomicassigninherited

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

Since
1.0
- (double) minScale
readwritenonatomicassigninherited

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

Since
1.0
- (NSString*) name
readwritenonatomiccopyinherited

The name of this layer

Since
10.1.1
- (CGFloat) opacity
readwritenonatomicassigninherited

The opacity of this layer as a value between 0(fully transparent) and 1(fully opaque)

Since
10.1.1
- (BOOL) renderNativeResolution
readwritenonatomicassigninherited

Gets a value that determines if the layer renders at the native resolution. This property will not have any affect on iOS devices without a retina display. If using an iOS device with a retina display and you want to take advantage of that display you can set this value to YES. If YES, this layer will use more memory and network bandwidth, but the layer will render at a higher resolution. This property is not settable for every layer type.

Since
2.1
- (AGSSpatialReference*) spatialReference
readnonatomicstronginherited

The spatial reference of the layer.

Since
1.0
- (BOOL) spatialReferenceStatusValid
readwritenonatomicassigninherited

This property will be NO until the spatial reference status has been initialized. See the layer:didInitializeSpatialReferenceStatus method on delegate for more information.

- (AGSTileInfo*) tileInfo
readnonatomicstrong

Tiling scheme for the layer. This property must be implemented by subclasses.

Since
1.0
- (BOOL) timeAware
readnonatomicassigninherited

A property indicating whether the layer is time-aware.

Since
1.0
- (BOOL) visible
readwritenonatomicassigninherited

Indicates whether this layer should be visible in the map.

Since
10.1.1