Platforms to show: All Mac Windows Linux Cross-Platform

Back to MKTileOverlayMBS class.

MKTileOverlayMBS.boundingMapRect as MKMapRectMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The projected rectangle that encompasses the overlay.

This property contains the smallest rectangle that completely encompasses the overlay. Implementers of this interface must set this area when implementing their overlay class, and after setting it, you must not change it. The rectangle should be specified using projected coordinates—that is, coordinates obtained by projecting the globe onto a two-dimensional surface.

Part of the MKOverlayMBS interface.

MKTileOverlayMBS.canReplaceMapContent as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns a Boolean indicating whether the overlay content replaces the underlying map content.

true if the map view can skip the loading and drawing of the underlying map tiles or false if the map tiles should still be drawn.

The map view uses the return value of this method as a hint to determine whether it should load and render its tiles. If your overlay covers its designated region entirely with opaque content, and effectively replaces the content of underlying map tiles, implement this method and return true. Doing so alleviates the need for the map to render its tiles.
If you do not implement this method, or if you return false from it, the map view continues to load and render its tiles.

Part of MKOverlayMBS interface.

See also:

MKTileOverlayMBS.Constructor(Handle as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 21.3 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Constructor for creating an instanced based on an existing handle.

Useful if you get a MKTileOverlay reference from a declare.
The object is retained.

See also:

MKTileOverlayMBS.Constructor(URL as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Initializes and returns a tile overlay object using the specified tile-access template.

URLTemplate: A string that can be used to build a URL to access your tile images. The string you specify can point to a local file or to an image on a remote server. To facilitate retrieving multiple tiles using the string, use the placeholder values {x}, {y}, {z}, and {scale} as stand-ins for the x and y tile indexes, the zoom level, and the resolution of the tile image. If this parameter is nil, you must provide custom implementations for the tile-loading methods of this class.

Returns an initialized tile overlay object.

The default tile overlay object uses the template string you specify to request tiles. This template string should incorporate the {x}, {y}, {z}, and {scale} placeholder strings to facilitate the creation of a URL for requesting the appropriate tile. For example, if you have a server that vends tiles when you provide a URL of the form http://myserver/tile?x=0&y=0&z=0&scale=1.0, you would specify a template string of http://myserver/tile?x={x}&y={y}&z={z}&scale={scale}. The tile overlay object substitutes actual index values in for your template’s placeholders before requesting the actual tile.

See also:

MKTileOverlayMBS.Coordinate as CLLocationCoordinate2DMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The coordinate of the annotation.

Part of the MKAnnotationMBS interface.

See also:

MKTileOverlayMBS.intersectsMapRect(mapRect as MKMapRectMBS) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Whether this overlay intersects with the given map rectangle.

Part of the MKOverlayMBS interface.

MKTileOverlayMBS.loadTileAtPath(Path as MKTileOverlayPathMBS, tag as Variant = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Loads the specified tile asynchronously.

Path: The path structure that identifies the specific tile you want. This structure incorporates the tile’s X-Y coordinate at a given zoom level and scale factor.

The default implementation of this method uses the URLForTilePath method to retrieve the URL for the specified tile and then loads that tile into memory asynchronously using an NSURLConnectionMBS object. The specified tile may be located either on the local file system or on a remote server. Subclasses may override this method and implement their own custom tile-loading behavior.

When a tile overlay renderer (that is, an instance of MKTileOverlayRendererMBS) needs to display tiles, it uses this method to request the data for each tile.

MKTileOverlayMBS.SetCoordinate(newCoordinate as CLLocationCoordinate2DMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Set the coordinate of the annotation.

Part of the MKAnnotationMBS interface.

MKTileOverlayMBS.SubTitle as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The subtitle of the item.

Part of the MKOverlayMBS interface.

See also:

MKTileOverlayMBS.Title as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
The title of the annotation.

Part of the MKAnnotationMBS interface.

See also:

MKTileOverlayMBS.URLForTilePath(Path as MKTileOverlayPathMBS) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method MapKit MBS MacFrameworks Plugin 19.0 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
Returns the URL to use to access the specified tile.

path: The path structure that identifies the specific tile you want. This structure incorporates the tile’s X-Y coordinate at a given zoom level and scale factor.

Returns the URL to use to retrieve the tile.

The default implementation of this method uses the template string you provided at initialization time to build a URL to the specified tile image. Subclasses can override this method and use a different scheme to provide URLs for tiles. Tiles can be located either on a local file system or on a remote server.

The items on this page are in the following plugins: MBS MacFrameworks Plugin.


The biggest plugin in space...