MapKitViewControlMBS.annotationViewDidChangeDragState(mapView as MKMapViewMBS, annotationView as MKAnnotationViewMBS, newState as Integer, oldState as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the drag state of one of its annotation views changed.

mapView: The map view containing the annotation view.
annotationView: The annotation view whose drag state changed.
newState: The new drag state of the annotation view.
oldState: The previous drag state of the annotation view.

The drag state typically changes in response to user interactions with the annotation view. However, the annotation view itself is responsible for changing that state as well.

MapKitViewControlMBS.beginGestureWithEvent(e as NSEventMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.2	✅ Yes	❌ No	❌ No	❌ No

Informs the receiver that the user has begun a touch gesture.

e: An event object representing the gesture beginning.
The event will be sent to the view under the touch in the key window.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

MapKitViewControlMBS.BoundsChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The event called when the bounds, but not the frame, changed.

MapKitViewControlMBS.Close

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

The control is about to close.
In Xojo version 2021r3 and newer this event is named Closing.

MapKitViewControlMBS.Closing

Type	Topic	Version
event	MapKit	14.1

The control is about to close.
In older Xojo versions, this event is named Close.

MapKitViewControlMBS.ClusterAnnotationForMemberAnnotations(mapView as MKMapViewMBS, memberAnnotations() as MKAnnotationMBS) as MKClusterAnnotationMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	19.0	✅ Yes	❌ No	❌ No	❌ No

Asks you to provide a cluster annotation object for the specified annotations.

mapView: The map view containing the specified annotations.
memberAnnotations: The annotations to be clustered together. The returned MKClusterAnnotation object must include the specific annotations in this parameter.

Return the cluster annotation object.

Use this method to customize the cluster annotations displayed on your map. Normally, MapKit creates cluster annotation objects automatically when one or more annotations with the same cluster identifier are too close together. However, you can implement this method and return a custom cluster annotation object for the specified set of annotations.

MapKitViewControlMBS.ConstructContextualMenu(base as MenuItem, x as Integer, y as Integer) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	22.1	✅ Yes	❌ No	❌ No	❌ No

This event is called when it is appropriate to display a contextual menu for the control.

MapKitViewControlMBS.ContextualMenuAction(hitItem as MenuItem) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

Called when a menuitem is choosen.

This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.

MapKitViewControlMBS.didAddAnnotationViews(mapView as MKMapViewMBS, AnnotationViews() as MKAnnotationViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that one or more annotation views were added to the map.

mapView: The map view that added the annotation views.
views: An array of MKAnnotationView objects representing the views that were added.

By the time this method is called, the specified views are already added to the map.

MapKitViewControlMBS.DidAddOverlayRenderers(mapView as MKMapViewMBS, renderers() as MKOverlayRendererMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	19.0	✅ Yes	❌ No	❌ No	❌ No

Tells you that one or more renderer objects were added to the map.

mapView: The map view that added the renderer objects.
renderers: The renderer objects that were added.

The map view adds renderer objects when it needs them to draw their contents, which might be prior to those contents appearing onscreen. It calls this method to let you know that the renderer is active and in use. By the time this method is called, the specified renderers have already been added to the map.

MapKitViewControlMBS.didAddOverlayViews(mapView as MKMapViewMBS, overlayViews() as NSViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	19.0	✅ Yes	❌ No	❌ No	❌ No

The event to inform you about added overlay views.

MapKitViewControlMBS.didCloseContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)   New in 24.1

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No

Did close contextual menu.

Allows you to restart any animation you may have stopped in the willShowContextualMenu event.

MapKitViewControlMBS.didDeselectAnnotationView(mapView as MKMapViewMBS, view as MKAnnotationViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that one of its annotation views was deselected.

mapView: The map view containing the annotation view.
view: The annotation view that was deselected.

You can use this method to track changes in the selection state of annotation views.

MapKitViewControlMBS.didFailLoadingMap(mapView as MKMapViewMBS, error as NSErrorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the specified view was unable to load the map data.

mapView: The map view that started the load operation.
error: The reason that the map data could not be loaded.

This method might be called in situations where the device does not have access to the network or is unable to load the map data for some reason. It may also be called if a request for additional map tiles comes in while a previous request for tiles is still pending. You can use this message to notify the user that the map data is unavailable.

MapKitViewControlMBS.didFailToLocateUserWithError(mapView as MKMapViewMBS, error as NSErrorMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that an attempt to locate the user's position failed.

mapView: The map view that is tracking the user's location.
error: An error object containing the reason why location tracking failed.

MapKitViewControlMBS.didFinishLoadingMap(mapView as MKMapViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the specified map view successfully loaded the needed map data.

mapView: The map view that started the load operation.

This method is called when the map tiles associated with the current request have been loaded. Map tiles are requested when a new visible area is scrolled into view and tiles are not already available. Map tiles may also be requested for portions of the map that are not currently visible. For example, the map view may load tiles immediately surrounding the currently visible area as needed to handle small pans by the user.

MapKitViewControlMBS.DidFinishRenderingMap(mapView as MKMapViewMBS, fullyRendered as boolean)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	19.0	✅ Yes	❌ No	❌ No	❌ No

Tells you that the map view has finished rendering all visible tiles.

fullyRendered: This parameter is set to true if the map view was able to render all tiles completely or false if errors prevented all tiles from being rendered.

This method lets you know when the map view finishes rendering all of the currently visible tiles to the best of its ability. This method is called regardless of whether all tiles were rendered successfully. If there were errors loading one or more tiles that prevented map view from rendering them, the fullyRendered parameter is set to false.

MapKitViewControlMBS.didSelectAnnotationView(mapView as MKMapViewMBS, view as MKAnnotationViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that one of its annotation views was selected.

mapView: The map view containing the annotation view.
view: The annotation view that was selected.

You can use this method to track changes in the selection state of annotation views.

MapKitViewControlMBS.didStopLocatingUser(mapView as MKMapViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the map view stopped tracking the user's location.

mapView: The map view that stopped tracking the user's location.

This method is called when the value of the showsUserLocation property changes to false.

MapKitViewControlMBS.didUpdateUserLocation(mapView as MKMapViewMBS, userLocation as MKUserLocationMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the location of the user was updated.

mapView: The map view that is tracking the user's location.
userLocation: The location object representing the user's latest location. This property may be nil.

While the showsUserLocation property is set to true, this method is called whenever a new location update is received by the map view. This method is also called if the map view's user tracking mode is set to MKUserTrackingModeFollowWithHeading and the heading changes.

This method is not called if the application is currently running in the background. If you want to receive location updates while running in the background, you must use the Core Location framework.

MapKitViewControlMBS.EnableMenuItems

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The event where you can enable menu items.
In Xojo version 2021r3 and newer this event is named MenuBarSelected.

MapKitViewControlMBS.endGestureWithEvent(e as NSEventMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.2	✅ Yes	❌ No	❌ No	❌ No

Informs the receiver that the user has ended a touch gesture.

e: An event object representing the gesture end.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

MapKitViewControlMBS.FocusLost

Type	Topic	Version
event	MapKit	16.5

The control lost focus.
In older Xojo versions, this event is named LostFocus.

This only fires if the control itself lost focus and not a sub control.

MapKitViewControlMBS.FocusReceived

Type	Topic	Version
event	MapKit	16.5

The control itself got focus.
In older Xojo versions, this event is named GotFocus.

This only fires if the control itself got focus and not a sub control.

MapKitViewControlMBS.FrameChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The event called when the frame changed.

This event notifies you, that the control changed it's bounding frame, which is position and/or size.

MapKitViewControlMBS.GotFocus

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	16.5	✅ Yes	❌ No	❌ No	❌ No

The control itself got focus.
In Xojo version 2021r3 and newer this event is named FocusReceived.

This only fires if the control itself got focus and not a sub control.

MapKitViewControlMBS.LostFocus

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	16.5	✅ Yes	❌ No	❌ No	❌ No

The control lost focus.
In Xojo version 2021r3 and newer this event is named FocusLost.

This only fires if the control itself lost focus and not a sub control.

MapKitViewControlMBS.magnifyWithEvent(e as NSEventMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.2	✅ Yes	❌ No	❌ No	❌ No

Informs the receiver that the user has begun a pinch gesture.

e: An event object representing the magnify gesture.
The event will be sent to the view under the touch in the key window.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

MapKitViewControlMBS.MenuBarSelected

Type	Topic	Version
event	MapKit	17.1

The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.

MapKitViewControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The mouse button was pressed inside the control’s region at the location passed in to x, y.

The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control.
Return True if you are going to handle the MouseDown. In such a case:

• The Action event, if any, will not execute and the state of the object will not change.
• You will receive the MouseDrag and MouseUp events.

If you return False, the system handles the MouseDown so the above event handlers do not get called.

MapKitViewControlMBS.MouseDrag(x as Integer, y as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

This event fires continuously after the mouse button was pressed inside the Control.

Mouse location is local to the control passed in to x, y.
As this event is fired continuously (hundreds of time per second), it is your responsibility to determine if the mouse has really moved.

MapKitViewControlMBS.MouseUp(x as Integer, y as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The mouse button was released.

Use the x and y parameters to determine if the mouse button was released within the control's boundaries.

MapKitViewControlMBS.Open

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

The control is about to was created and you can initialize it.
In Xojo version 2021r3 and newer this event is named Opening.

MapKitViewControlMBS.Opening

Type	Topic	Version
event	MapKit	14.1

The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.

MapKitViewControlMBS.pressureChange(e as NSEventMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	15.1	✅ Yes	❌ No	❌ No	❌ No

Informs the current object that a pressure change occurred on a system that supports pressure sensitivity.

This method is invoked automatically in response to user actions. event is the event that initiated the change in pressure.
Available in OS X v10.10.3 and later.

MapKitViewControlMBS.regionDidChangeAnimated(mapView as MKMapViewMBS, animated as boolean)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the region displayed by the map view just changed.

mapView: The map view whose visible region changed.
animated: If true, the change to the new region was animated.

This method is called whenever the currently displayed map region changes. During scrolling, this method may be called many times to report updates to the map position. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting scrolling performance.

MapKitViewControlMBS.regionWillChangeAnimated(mapView as MKMapViewMBS, animated as boolean)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the region displayed by the map view is about to change.

mapView: The map view whose visible region is about to change.
animated: If true, the change to the new region will be animated. If NO, the change will be made immediately.

This method is called whenever the currently displayed map region changes. During scrolling, this method may be called many times to report updates to the map position. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting scrolling performance.

MapKitViewControlMBS.rendererForOverlay(mapView as MKMapViewMBS, overlay as MKOverlayMBS) as MKOverlayRendererMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	19.0	✅ Yes	❌ No	❌ No	❌ No

Asks the control for a renderer object to use when drawing the specified overlay.

mapView: The map view that requested the renderer object.
overlay: The overlay object that is about to be displayed.

Return the renderer to use when presenting the specified overlay on the map.

You must implement this method and use it to provide an appropriate renderer object for your overlays. The renderer object is responsible for drawing the contents of your overlay when asked to do so by the map view. Map Kit supports many different types of standard renderer objects and you may also define your own custom renderers.

If you don't implement this event, the MBS Plugin returns a default renderer.

MapKitViewControlMBS.rotateWithEvent(e as NSEventMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.2	✅ Yes	❌ No	❌ No	❌ No

Informs the receiver that the user has begun a rotation gesture.

e: An event object representing the rotate gesture.
The event will be sent to the view under the touch in the key window.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

MapKitViewControlMBS.ScaleFactorChanged(NewFactor as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.

MapKitViewControlMBS.swipeWithEvent(e as NSEventMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.2	✅ Yes	❌ No	❌ No	❌ No

Informs the receiver that the user has begun a swipe gesture.

e: An event object representing the swipe gesture.
The event will be sent to the view under the touch in the key window.
Available in Mac OS X v10.6 and later.
Return true if you handled this event.

MapKitViewControlMBS.viewForAnnotation(mapView as MKMapViewMBS, annotation as MKAnnotationMBS) as MKAnnotationViewMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	19.0	✅ Yes	❌ No	❌ No	❌ No

The event to query an annotation view for the given annotation.

MapKitViewControlMBS.willShowContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)   New in 24.1

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No

Will show contextual menu.

Your chance to modify the menu before it is shown, e.g. to add menu entries.

MapKitViewControlMBS.willStartLoadingMap(mapView as MKMapViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the specified map view is about to retrieve some map data.

mapView: The map view that began loading the data.

This method is called whenever a new group of map tiles need to be downloaded from the server. This typically occurs whenever you expose portions of the map by panning or zooming the content. You can use this method to mark the time that it takes for the map view to load the data.

MapKitViewControlMBS.willStartLocatingUser(mapView as MKMapViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	14.1	✅ Yes	❌ No	❌ No	❌ No

Tells the control that the map view will start tracking the user's position.

mapView: The map view that is tracking the user's location.

This method is called when the value of the showsUserLocation property changes to true.

MapKitViewControlMBS.WillStartRenderingMap(mapView as MKMapViewMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	MapKit	MBS MacFrameworks Plugin	19.0	✅ Yes	❌ No	❌ No	❌ No

Tells you that the map view is about to start rendering some of its tiles.

The map view calls this method when one or more tiles are revealed and require rendering.