MLNOverlay class interface

The MLNOverlay protocol defines a specific type of annotation that represents both a point and an area on a map. Overlay objects are essentially data objects that contain the geographic data needed to represent the map area. Overlays can take the form of a polyline or polygon.

You use overlays to layer more sophisticated content on top of a map view. For example, you could use an overlay to show the boundaries of a national park or trace a bus route along city streets. This SDK defines several concrete classes that conform to this protocol and define standard shapes.

Implemented types

MLNAnnotation

Implementers

Constructors

MLNOverlay.castFrom(ObjCObjectBase other): Constructs a MLNOverlay that points to the same underlying object as other.
MLNOverlay.castFromPointer(Pointer<ObjCObject> other, {bool retain = false, bool release = false}): Constructs a MLNOverlay that wraps the given raw object pointer.

Properties

hashCode → int: The hash code for this object.
no setterinherited
ref → ObjCObjectRef: finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

$protocol → Protocol: Returns the objc.Protocol object for this protocol.
no setter
coordinate → ObjCProtocolMethod<CLLocationCoordinate2D Function()>: The center point (specified as a map coordinate) of the annotation. (required) (read-only)
final
intersectsOverlayBounds_ → ObjCProtocolMethod<bool Function(MLNCoordinateBounds)>: Returns a Boolean indicating whether the specified rectangle intersects the receiver’s shape.
final
overlayBounds → ObjCProtocolMethod<MLNCoordinateBounds Function()>: The cooordinate rectangle that encompasses the overlay. (required) (read-only)
final
subtitle → ObjCProtocolMethod<NSString? Function()>: The string containing the annotation’s subtitle.
final
title → ObjCProtocolMethod<NSString? Function()>: The string containing the annotation’s title.
final

Static Methods

addToBuilder(ObjCProtocolBuilder builder, {required CLLocationCoordinate2D coordinate(), required MLNCoordinateBounds overlayBounds(), required bool intersectsOverlayBounds_(MLNCoordinateBounds), NSString? title()?, NSString? subtitle()?, bool $keepIsolateAlive = true}) → void: Adds the implementation of the MLNOverlay protocol to an existing objc.ObjCProtocolBuilder.
override
conformsTo(ObjCObjectBase obj) → bool: Returns whether obj is an instance of MLNOverlay.
override
implement({required CLLocationCoordinate2D coordinate(), required MLNCoordinateBounds overlayBounds(), required bool intersectsOverlayBounds_(MLNCoordinateBounds), NSString? title()?, NSString? subtitle()?, bool $keepIsolateAlive = true}) → MLNOverlay: Builds an object that implements the MLNOverlay protocol. To implement multiple protocols, use addToBuilder or objc.ObjCProtocolBuilder directly.
override