Discussion

The network timeout for each attempt to download a tile image.

Discussion

The number of times to retry downloads of a given tile image.

Discussion

Provide the URL for a given tile.

Discussion

Provide multiple URLs for a given tile. Each URL is fetched in turn and composited together before placement on the map. URLs are ordered from the bottom layer to the top layer.

Discussion

An arbitrary icon image for the annotation. Useful to pass an image at annotation creation time for use in the layer at a later time.

Discussion

An arbitrary string representing the type of annotation. Useful for determining which layer to draw for the annotation when requested in the delegate. Cluster annotations, which are automatically created by a map view, will automatically have an annotationType of RMClusterAnnotation.

Discussion

If the annotation is a cluster annotation, returns an array containing the annotations in the cluster. Returns nil if the annotation is not a cluster annotation.

Discussion

Whether the annotation should be clustered when map view clustering is enabled. Defaults to YES.

Discussion

The annotation’s location on the map.

Discussion

Whether touch events for the annotation’s layer are recognized. Defaults to YES.

Discussion

Whether the annotation is currently on the screen, regardless if clustered or not.

Discussion

Whether the annotation is currently visible on the screen. An annotation is not visible if it is either offscreen or currently in a cluster.

Discussion

Whether an annotation is an automatically-managed cluster annotation.

Discussion

Whether the annotation is related to display of the user’s location. Useful for filtering purposes when providing annotation layers in the delegate.

Discussion

An object representing the annotation’s visual appearance.

Discussion

The annotation’s current location on screen. Do not set this directly unless during temporary operations like annotation drags, but rather use the coordinate property to permanently change the annotation’s location on the map.

Discussion

The annotation’s subtitle.

Discussion

The annotation’s title.

Discussion

Storage for arbitrary data.

Discussion

Create and initialize an annotation.

Discussion

Initialize an annotation.

Discussion

Whether the annotation is within a certain screen bounds.

Discussion

The unique identifier for the cache.

Discussion

The object to be cached, typically a UIImage.

Discussion

The tile key for the cache object.

Discussion

The freshness timestamp for the cache object.

Discussion

Creates and returns a cache object for a given key and object to store in a given cache.

Discussion

Initializes and returns a newly allocated cache object for a given key and object to store in a given cache.

Discussion

Updates the timestamp on a cache object to indicate freshness. Objects with older timestamps get deleted first when space is needed.

Discussion

The circle’s fill color. Defaults to blue.

Discussion

The fill pattern image of the circle. If set, the fillColor is set to nil.

Discussion

The circle’s line color. Defaults to black.

Discussion

The circle’s line width. Defaults to 10.0.

Discussion

The radius of the circle in projected meters. Regardless of map zoom, the circle will change visible size to continously represent this radius on the map.

Discussion

The circle’s underlying shape layer.

Discussion

Initializes and returns a newly allocated RMCircle for the specified map view.

Discussion

Access and change the global user agent for HTTP requests using the library.

If unset, defaults to MapBox iOS SDK followed by generic hardware model and software version information.

Example: MyMapApp/1.2

Discussion

Access the shared instance of the configuration.

Discussion

Access the disk- and memory-based cache configuration.

Discussion

The capacity, in number of tiles, that the database cache can hold.

Discussion

The path to the SQLite database on disk that backs the cache.

Discussion

Initializes and returns a newly allocated database cache object.

Discussion

Initializes and returns a newly allocated database cache object at the given disk path.

Discussion

Set the maximum tile count allowed in the database.

Discussion

Set the expiry period for cache purging.

Discussion

Set the minimum number of tiles to purge when clearing space in the cache.

Discussion

Set the cache purge strategy to use for the database.

Discussion

A suggested starting center coordinate for the map layer.

Discussion

A suggested starting center zoom level for the map layer.

Discussion

Returns YES if the tile source provides full-world coverage; otherwise, returns NO.

Discussion

Initialize and return a newly allocated MBTiles tile source based on a given bundle resource.

Discussion

Initialize and return a newly allocated MBTiles tile source based on a given local database URL.

Discussion

Any available HTML-formatted map legend data for the tile source, suitable for display in a UIWebView.

Discussion

Image quality that is retrieved from the network. Useful for lower-bandwidth environments. The default is to provide full-quality imagery.

Note that you may want to clear the tile cache after changing this value in order to provide a consistent experience.

Discussion

The TileJSON data in dictionary format. Useful for retrieving info about the layer without having to parse TileJSON.

Discussion

The TileJSON for the map layer. Useful for saving locally to use in instantiating a tile source while offline.

Discussion

The TileJSON URL for the map layer. Useful for retrieving TileJSON to save locally to use in instantiating a tile source while offline.

Discussion

A suggested starting center coordinate for the map layer.

Discussion

A suggested starting center zoom level for the map layer.

Discussion

Returns YES if the tile source provides full-world coverage; otherwise, returns NO.

Discussion

Initialize a tile source using the MapBox map ID.

Discussion

For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from simplestyle data.

Discussion

Initialize a tile source with either a remote or local TileJSON structure.

Discussion

For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from simplestyle data.

Discussion

Initialize a tile source with TileJSON.

Discussion

For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from simplestyle data.

Discussion

Any available HTML-formatted map legend data for the tile source, suitable for display in a UIWebView.

Discussion

The annotation associated with the layer. This can be useful to inspect the annotation’s userInfo in order to customize the visual representation.

Discussion

The offset (in pixels) at which to place the callout bubble.

This property determines the additional distance by which to move the callout bubble. When this property is set to (0, 0), the anchor point of the callout bubble is placed on the top-center point of the annotation view’s frame. Specifying positive offset values moves the callout bubble down and to the right, while specifying negative values moves it up and to the left.

Discussion

A Boolean value indicating whether the annotation layer is able to display extra information in a callout bubble.

If the value of this property is YES, a standard callout bubble is shown when the user taps the layer. The callout uses the title text from the associated annotation object. If there is no title text, though, the annotation is treated as if its enabled property is set to NO. The callout also displays any custom callout views stored in the leftCalloutAccessoryView and rightCalloutAccessoryView properties.

If the value of this property is NO, the value of the title string is ignored and the annotation remains enabled by default. You can still disable the annotation explicitly using the enabled property.

Note that callouts are not supported on cluster annotation layers. These annotations can be interacted with, but do not remain consistent visually during map pan and zoom events; thus, callout behavior would be inconsistent.

Discussion

When set to YES, the layer can be dragged by the user.

Discussion

The view to display on the left side of the standard callout bubble.

The default value of this property is nil. The left callout view is typically used to display information about the annotation or to link to custom information provided by your application. The height of your view should be 32 pixels or less.

If the view you specify is also a descendant of the UIControl class, you can use the map view’s delegate to receive notifications when your control is tapped. If it does not descend from UIControl, your view is responsible for handling any touch events within its bounds.

Discussion

The current projected location of the layer on the map.

Discussion

The view to display on the right side of the standard callout bubble.

This property is set to nil by default. The right callout view is typically used to link to more detailed information about the annotation. The height of your view should be 32 pixels or less. A common view to specify for this property is UIButton object whose type is set to UIButtonTypeDetailDisclosure.

If the view you specify is also a descendant of the UIControl class, you can use the map view’s delegate to receive notifications when your control is tapped. If it does not descend from UIControl, your view is responsible for handling any touch events within its bounds.

Discussion

Storage for arbitrary data.

Discussion

Set the screen position of the layer.

Discussion

A Boolean value that adjusts the display of map tile images for retina-capable screens.

If set to YES, the map tiles are drawn at double size, typically 512 pixels square instead of 256 pixels, in order to compensate for smaller features and to make them more legible. If tiles designed for retina devices are used, this value should be set to NO in order to display these tiles at the proper size. The default value is NO.

Discussion

The annotations currently added to the map. Includes user location annotations, if any.

Discussion

A custom, static view to use behind the map tiles. The default behavior is to use grid imagery that moves with map panning like MapKit.

Discussion

A Boolean value that determines whether the map view bounces past the edge of content and back again and whether it animates the content scaling when the scaling exceeds the maximum or minimum limits.

If the value of this property is YES, the map view bounces when it encounters a boundary of the content or when zooming exceeds either the maximum or minimum limits for scaling. Bouncing visually indicates that scrolling or zooming has reached an edge of the content. If the value is NO, scrolling and zooming stop immediately at the content boundary without bouncing.

The default value is NO.

Discussion

The center coordinate of the map view.

Discussion

The center point of the map represented as a projected point.

Discussion

Whether to enable clustering of map point annotations. Defaults to NO.

Discussion

A Boolean value indicating whether to draw tile borders and z/x/y numbers on tile images for debugging purposes. Defaults to NO.

Discussion

A custom deceleration mode for the map view for drag operations. Set to RMMapDecelerationOff to disable map drag deceleration. The default value is RMMapDecelerationFast.

Discussion

The receiver’s delegate.

A map view sends messages to its delegate regarding the loading of map data and changes in the portion of the map being displayed. The delegate also manages the annotation layers used to highlight points of interest on the map.

The delegate should implement the methods of the RMMapViewDelegate protocol.

Discussion

Whether the map view should display a heading calibration alert when necessary. The default value is YES.

Discussion

A Boolean value that determines whether the user may scroll around the map.

This property controls only user interactions with the map. If you set the value of this property to NO, you may still change the map location programmatically.

The default value of this property is YES.

Discussion

Whether to hide map data attribution for the map view.

If this is set to NO, a small disclosure button will be added to the lower-right of the map view, allowing the user to tap it to display a modal view showing map data attribution info. The modal presentation uses a page curl animation to reveal the attribution info under the map view.

The default value is NO, meaning that attribution info will be shown. Please ensure that the terms & conditions of any map data used in your application are satisfied before setting this value to YES.

Discussion

The maximum zoom level of the map, clamped to the range supported by the tile source(s).

Discussion

The minimum zoom level of the map, clamped to the range supported by the tile source(s).

Discussion

Take missing tiles from lower-numbered zoom levels, up to a given number of zoom levels. This can be used in order to increase perceived tile load performance or to allow zooming in beyond levels supported natively by a given tile source. Defaults to 1.

Discussion

Whether to order cluster markers above non-clustered markers. Defaults to NO.

Discussion

Whether to order markers on the z-axis according to increasing y-position. Defaults to YES.

Discussion

Whether to position cluster markers at the weighted center of the points they represent. If YES, position clusters in weighted fashion. If NO, position them on a rectangular grid. Defaults to YES.

Discussion

The annotation that is currently selected.

Discussion

A Boolean value indicating whether to show a small logo in the corner of the map view. Defaults to YES.

Discussion

A Boolean value indicating whether the map may display the user location.

This property does not indicate whether the user’s position is actually visible on the map, only whether the map view is allowed to display it. To determine whether the user’s position is visible, use the userLocationVisible property. The default value of this property is NO.

Setting this property to YES causes the map view to use the Core Location framework to find the current location. As long as this property is YES, the map view continues to track the user’s location and update it periodically.

Discussion

The tile cache for the map view, typically composed of both an in-memory RMMemoryCache and a disk-based RMDatabaseCache.

Discussion

The first tile source of a map view, ordered from bottom to top.

Discussion

All of the tile sources for a map view, ordered bottom to top.

Discussion

The annotation object representing the user’s current location. (read-only)

Discussion

A Boolean value indicating whether the device’s current location is visible in the map view. (read-only)

This property uses the horizontal accuracy of the current location to determine whether the user’s location is visible. Thus, this property is YES if the specific coordinate is offscreen but the rectangle surrounding that coordinate (and defined by the horizontal accuracy value) is partially onscreen.

If the user’s location cannot be determined, this property contains the value NO.

Discussion

The mode used to track the user location.

Discussion

The annotations currently visible on the map. May include annotations currently shown in clusters.

Discussion

The current zoom level of the map.

Discussion

A Boolean value that determines whether double-tap zooms of the map always zoom on the center of the map, or whether they zoom on the center of the double-tap gesture. The default value is NO, which zooms on the gesture.

Discussion

Add an annotation to the map.

Discussion

Add one or more annotations to the map.

Discussion

Add a tile source to a map view above the current tile sources.

Discussion

Add a tile source to a map view at a given index.

Discussion

Convert a coordinate to a screen location.

Discussion

Convert a coordiante to a projected point.

Discussion

Deselects the specified annotation and hides its callout view.

Discussion

Initialize a map view with a given frame. A default watermarked MapBox map tile source will be used.

Discussion

Initialize a map view with a given frame and tile source.

Discussion

Designated initializer. Initialize a map view.

Discussion

The smallest bounding box containing the entire map view.

Discussion

The smallest bounding box containing a rectangular region of the map view.

Discussion

Return the bounding box for a given map tile.

Discussion

The screen position for a given annotation.

Discussion

Move the map center by a given delta.

Discussion

Move the tile source at one index to another index.

Discussion

Convert a screen location to a coordinate.

Discussion

Convert a screen location to a projected point.

Discussion

Convert a projected point to a coordinate.

Discussion

Convert a projected point to a screen location.

Discussion

Reload the tiles for a given tile source.

Discussion

Reload the tiles for a tile source at a given index.

Discussion

Remove all annotations from the map. This does not remove user location annotations, if any.

Discussion

Clear all tile images from the caching system.

Discussion

Remove an annotation from the map.

Discussion

Remove one or more annotations from the map.

Discussion

Remove a tile source from the map view.

Discussion

Remove the tile source at a given index from the map view.

Discussion

Selects the specified annotation and displays a callout view for it.

If the specified annotation is not onscreen, and therefore does not have an associated annotation layer, this method has no effect.

Discussion

A custom image to use behind the map tiles. The default behavior is to show the default backgroundView and not a static image.

Discussion

Set the map center to a given coordinate.

Discussion

Set the map center to a given projected point.

Discussion

Contrain zooming and panning of the map view to a given coordinate boundary.

Discussion

Hide or show a tile source.

Discussion

Hide or show a tile source at a given index.

Discussion

Set the mode used to track the user location.

Discussion

Set zoom level, optionally with an animation.

Discussion

Set both zoom level and center coordinate at the same time, optionally with an animation.

Discussion

Take a snapshot of the map view.

By default, the overlay containing any visible annotations is also captured.

Discussion

Take a snapshot of the map view.

Discussion

Zoom the map by a given factor near a certain point.

Discussion

Zoom the map in at the next integral zoom level near a certain point.

Discussion

Zoom the map out at the next integral zoom level near a certain point.

Discussion

Zoom the map to a given latitude and longitude bounds.

Discussion

A custom label for the marker. The label is shown when first set.

Discussion

The marker object’s label text background color. Defaults to clear.

Discussion

The marker object’s label text foreground color. Defaults to black.

Discussion

Clears the local cache of Mapbox Marker images. Images are cached locally upon first use so that if the application goes offline, markers can still be used.

Discussion

The font used for labels when another font is not explicitly requested. The default is the system font with size 15.

Discussion

Changes the label to a UILabel with the supplied text and default marker font and using the existing text foreground and background colors.

Discussion

Changes the label to a UILabel with the supplied text and font and using the given text foreground and background colors.

Discussion

Hide the marker’s label, if any.

Discussion

Initializes and returns a newly allocated marker object using a red, medium-sized star pin image.

Discussion

Initializes and returns a newly allocated marker object using a red, medium-sized pin image and a given symbol name, e.g., bus.

Discussion

Initializes and returns a newly allocated marker object using a medium-sized pin image, a given symbol name, e.g., bus, and a given color.

Discussion

Initializes and returns a newly allocated marker object using a pin image, a given symbol name, e.g., bus, a given color, and a given size.

Discussion

Initializes and returns a newly allocated marker object using a medium-sized pin image, a given symbol name, e.g., bus, and a given HTML hex color, e.g., ff0000.

Discussion

Initializes and returns a newly allocated marker object using a pin image, a given symbol name, e.g., bus, a given HTML hex color, e.g., ff0000, and a given size, e.g., large.

Discussion

Initializes and returns a newly allocated marker object using the specified image.

Discussion

Initializes and returns a newly allocated marker object using the specified image and anchor point.

Discussion

Replace the image for a marker.

Discussion

Replace the image for a marker using a custom anchor point.

Discussion

Show the marker’s label, if any.

Discussion

Toggle the display of the marker’s label, if any. If hidden, show and if shown, hide.

Discussion

The capacity, in number of tiles, that the memory cache can hold.

Discussion

Initializes and returns a newly allocated memory cache object with the specified tile count capacity.

Discussion

Remove the least-recently used image from the cache if the cache is at or over capacity. This removes a single image from the cache.

Discussion

The array of polygons nested inside the receiver. (read-only)

When a polygon is rendered on screen, the area occupied by any interior polygons is masked out and not considered part of the polygon.

Discussion

Initialize a polygon annotation.

Discussion

The fill color of the shape. Defaults to clear.

Discussion

The fill pattern image of the shape. If set, the fillColor is set to nil.

Discussion

The line color of the shape. Defaults to black.

Discussion

The line width of the shape. Defaults to 2.0.

Discussion

The bounding box of the shape in the current viewport.

Discussion

Draw a curve from the current pen location to a coordinate.

Discussion

Draw a curve from the current pen location to a projected point.

Discussion

Draw a line from the current pen location to a coordinate.

Discussion

Draw a line from the current pen location to a projected point.

Discussion

Draw a line from the current pen location to a screen point.

Discussion

Draw a quad curve from the current pen location to a coordinate.

Discussion

Draw a quad curve from the current pen location to a projected point.

Discussion

Closes the path, connecting the last point to the first. After this action, no further points can be added to the path.

There is no requirement that a path be closed.

Discussion

Initializes and returns a newly allocated shape object for the specified map view.

Discussion

Move the drawing pen to a coordinate.

Discussion

Move the drawing pen to a projected point.

Discussion

Move the drawing pen to a screen point.

Discussion

Alter the path without rerecalculating the geometry. Recommended for many operations in order to increase performance.

Discussion

The array of points associated with the shape. (read-only)

Discussion

Initialize a shape annotation.

Discussion

Initialize a static map view with a given frame and mapID.

The map ID is expected to provide initial center coordinate and zoom level information, and may optionally also include simplestyle marker data, which will automatically be added to the map view.

Discussion

Initialize a static map view with a given frame, mapID, center coordinate, and zoom level.

The map ID may optionally also include simplestyle marker data, which will automatically be added to the map view.

Discussion

Designated initializer. Initialize a static map view with a given frame, mapID, center coordinate, and zoom level, performing a block upon completion of the map load.

The map ID may optionally also include simplestyle marker data, which will automatically be added to the map view. The block will be performed upon completion of the load of both the map and of any simplestyle markers included with the map ID.

Discussion

Initialize a static map view with a given frame and mapID, performing a block upon completion of the map load.

The map ID is expected to provide initial center coordinate and zoom level information, and may optionally also include simplestyle marker data, which will automatically be added to the map view. The block will be performed upon completion of the load of both the map and of any simplestyle markers included with the map ID.

Discussion

A delegate to notify of background tile cache download operations.

Discussion

Whether or not the tile cache is currently background caching.

Discussion

The list of caches managed by a cache manager. This could include memory-based, disk-based, or other types of caches.

Discussion

Return an identifying hash number for the specified tile.

Discussion

Adds a given cache to the cache management system.

Discussion

Tells the tile cache to begin background caching. Progress during the caching operation can be observed by implementing the RMTileCacheBackgroundDelegate protocol.

Discussion

Cancel any background caching.

This method returns immediately so as to not block the calling thread. If you wish to be notified of the actual cancellation completion, implement the tileCacheDidCancelBackgroundCache: delegate method.

Discussion

Initializes and returns a newly allocated cache object with specified expiry period.

If the init method is used to initialize a cache instead, a period of 0 is used. In that case, time-based expiration of tiles is not performed, but rather the cached tile count is used instead.

Discussion

Initialize and return a newly allocated TileMill tile source based on a given host and map name. This is ideal for testing on an actual iOS device if the network name or address of the computer running TileMill is passed as the host parameter.

Discussion

Initialize and return a newly allocated TileMill tile source based on a given map name. This assumes that TileMill is running on the local development computer (e.g., localhost), which will not work from an iOS device but will work in the iOS Simulator.

Discussion

The heading of the user location. (read-only)

This property is nil if the user location tracking mode is not RMUserTrackingModeFollowWithHeading.

Discussion

The current location of the device. (read-only)

This property contains nil if the map view is not currently showing the user location or if the user’s location has not yet been determined.

Discussion

A Boolean value indicating whether the user’s location is currently being updated. (read-only)

Discussion

The map view associated with this bar button item.

Discussion

Initializes a newly created bar button item with the specified map view.

Discussion

Returns the HTML-formatted output for a given point on a given map view.

Discussion

Returns YES if a map view supports interactivity features given its current tile sources.

Discussion

Returns the HTML-formatted output for a given point on a given map view, considering the currently active interactive tile source.

Discussion

Returns YES if a tile source supports interactivity features.

Discussion

Tells the delegate when a map has finished moving.

Discussion

Tells the delegate when a map has finished zooming.

Discussion

Tells the delegate when a map is about to move.

Discussion

Tells the delegate when a map is about to zoom.

Discussion

Tells the delegate when the user double-taps the layer for an annotation.

Discussion

Tells the delegate when the user double-taps the label for an annotation.

Discussion

Tells the delegate when the user double-taps a map view.