GMSMapView Class Reference

Initializes with CGRectZero and default options.

Creates a new map view with the given options.

The value of the options object is copied by this method.

Builds and returns a map view with a frame and camera target.

Convenience initializer to build and return a map view with a frame, map ID, and camera target.

Builds and returns a map view, with a frame and camera target.

Note:

This is deprecated. Use -init or -initWithOptions: instead.

Builds and returns a map view with a frame, map ID, and camera target.

Note:

This is deprecated. Use -init or -initWithOptions: instead.

Tells this map to power up its renderer.

This is optional and idempotent.

Note:

This is deprecated. This method is obsolete and will be removed in a future release.

Tells this map to power down its renderer.

This is optional and idempotent.

Note:

This is deprecated. This method is obsolete and will be removed in a future release.

Clears all markup that has been added to the map, including markers, polylines and ground overlays.

This will not clear the visible location dot or reset the current mapType.

Sets minZoom and maxZoom.

This method expects the minimum to be less than or equal to the maximum, and will throw an exception with name NSRangeException otherwise.

Build a GMSCameraPosition that presents bounds with padding.

The camera will have a zero bearing and tilt (i.e., facing north and looking directly at the Earth). This takes the frame and padding of this GMSMapView into account.

If the bounds is invalid this method will return a nil camera.

Changes the camera according to update.

The camera change is instantaneous (with no animation).

Check whether the given camera positions would practically cause the camera to be rendered the same, taking into account the level of precision and transformations used internally.

Returns a feature layer of the specified type.

Feature layers must be configured in the Cloud Console.

If a layer of the specified type does not exist on this map, or if data-driven styling is not enabled, or if the Metal rendering framework is not used, the resulting layer's `isAvailable` will be NO, and will not respond to any calls.

Requires the Metal renderer. Learn how to enable Metal at https://developers.google.com/maps/documentation/ios-sdk/config#use-metal

Returns a dataset feature layer of the specified dataset.

Dataset IDs must be configured in the Cloud Console.

If a dataset of the specified ID does not exist on this map, or if data-driven styling is not enabled, the resulting layer's `isAvailable` will be NO, and will not respond to any calls.

Invalidates an accessory view and triggers a re-layout for that view.

The view must be one of the current accessory views. If guidance is inactive, this call is a NO-OP instruction.

Sets the position of the accessory view below the primary header of the navigation UI.

Passing a nil value removes the accessory view. If guidance is inactive, this call is a NO-OP instruction.

@note If the map view is short, the SDK hides the accessory view due to limited space. The views are internally managed to optimize display of the map.

Animates the camera of this map to cameraPosition.

As animateToCameraPosition:, but changes only the location of the camera (i.e., from the current location to location).

As animateToCameraPosition:, but changes only the zoom level of the camera.

This value is clamped by [kGMSMinZoomLevel, kGMSMaxZoomLevel].

As animateToCameraPosition:, but changes only the bearing of the camera (in degrees).

Zero indicates true north.

As animateToCameraPosition:, but changes only the viewing angle of the camera (in degrees).

This value will be clamped to a minimum of zero (i.e., facing straight down) and between 30 and 45 degrees towards the horizon, depending on the relative closeness to the earth.

Applies cameraUpdate to the current camera, and then uses the result as per animateToCameraPosition:.

This method should be called from the application's implementation of the CPMapTemplateDelegate method -mapTemplateDidBeginPanGesture: in order to implement pan gestures for CarPlay map templates.

This function is in the pre-GA Experimental launch stage https://developers.google.com/maps/launch-stages#preview.

This method should be called from the application's implementation of the CPMapTemplateDelegate method -mapTemplate:didUpdatePanGestureWithTranslation: in order to implement pan gestures for CarPlay map templates.

This function is in the pre-GA Experimental launch stage https://developers.google.com/maps/launch-stages#preview.

This method should be called from the application's implementation of the CPMapTemplateDelegate method -mapTemplate:didEndPanGestureWithVelocity: in order to implement pan gestures for CarPlay map templates.

This function is in the pre-GA Experimental launch stage https://developers.google.com/maps/launch-stages#preview.

Begins navigation in this map view using the given navigation session.

Note:

for the most efficient use of memory and CPU, call this method before invoking any other navigation-related methods on this map view.

Returns:

Whether navigation was successfully started (for instance, NO will be returned if the terms and conditions have not yet been accepted).

Accessibility identifier for the compass button.

Accessibility identifier for the "my location" button.

Accessibility identifier for the "out of quota" error label.

GMSMapView delegate.

Controls the camera, which defines how the map is oriented.

Modification of this property is instantaneous.

Returns a GMSProjection object that you can use to convert between screen coordinates and latitude/longitude coordinates.

This is a snapshot of the current projection, and will not automatically update when the camera moves. It represents either the projection of the last drawn GMSMapView frame, or; where the camera has been explicitly set or the map just created, the upcoming frame. It will never be nil.

Controls whether the My Location dot and accuracy circle is enabled.

Defaults to NO.

If My Location is enabled, reveals where the device location dot is being drawn.

If it is disabled, or it is enabled but no location data is available, this will be nil. This property is observable using KVO.

The marker that is selected.

Setting this property selects a particular marker, showing an info window on it. If this property is non-nil, setting it to nil deselects the marker, hiding the info window. This property is observable using KVO.

Controls whether the map is drawing traffic data, if available.

This is subject to the availability of traffic data. Defaults to NO.

Controls the type of map tiles that should be displayed.

Defaults to kGMSTypeNormal.

Controls the style of the map.

A non-nil mapStyle will only apply if mapType is Normal.

Change the map to desired [UIUserInterfaceStyle](https://developer.apple.com/documentation/uikit/uiuserinterfacestyle?language=objc).

This overrides the default UIKit behavior and defaults to UIUserInterfaceStyleLight to ensure backwards compatibility. This affects the color scheme of Normal and Terrain map types.

Minimum zoom (the farthest the camera may be zoomed out).

Defaults to kGMSMinZoomLevel. Modified with -setMinZoom:maxZoom:.

Maximum zoom (the closest the camera may be to the Earth).

Defaults to kGMSMaxZoomLevel. Modified with -setMinZoom:maxZoom:.

If set, 3D buildings will be shown where available.

Defaults to YES.

This may be useful when adding a custom tile layer to the map, in order to make it clearer at high zoom levels. Changing this value will cause all tiles to be briefly invalidated.

Sets whether indoor maps are shown, where available.

Defaults to YES.

If this is set to NO, caches for indoor data may be purged and any floor currently selected by the end-user may be reset.

Gets the GMSIndoorDisplay instance which allows to observe or control aspects of indoor data display.

Gets the GMSUISettings object, which controls user interface settings for the map.

Controls the 'visible' region of the view.

By applying padding an area around the edge of the view can be created which will contain map data but will not contain UI controls.

If the padding is not balanced, the visual center of the view will move as appropriate. Padding will also affect the projection property so the visible region will not include the padding area. GMSCameraUpdate fitToBounds will ensure that both this padding and any padding requested will be taken into account.

This property may be animated within a UIView-based animation block.

Controls how safe area insets are added to the padding values.

Like padding, safe area insets position map controls such as the compass, my location button and floor picker within the device safe area.

Defaults to kGMSMapViewPaddingAdjustmentBehaviorAlways.

Defaults to YES.

If set to NO, GMSMapView will generate accessibility elements for overlay objects, such as GMSMarker and GMSPolyline.

This property follows the informal UIAccessibility protocol, except for the default value of YES.

Accessor for the custom CALayer type used for the layer.

Controls the rendering frame rate.

Default value is kGMSFrameRateMaximum.

If not nil, constrains the camera target so that gestures cannot cause it to leave the specified bounds.

All conditionally-available (dependent on mapID or other map settings) capabilities that are available at the current moment in time.

Does not include always-available capabilities.

A delegate of GMSMapView which receives callbacks for navigation UI events.

Whether navigation functionality is enabled for this map.

If this is YES, routes and turn-by-turn directions can be displayed on the map, the camera can enter following mode, and the re-center button appears when the camera is not following the device location.

If the user has not accepted the Google Navigation terms and conditions, setting this property will have no effect. To show the terms and conditions dialog, see the methods on GMSNavigationServices.

The navigator for this GMSMapView which allows routes to be requested and turn-by-turn guidance to be started.

If the user has not accepted the Google Navigation terms and conditions, this will be nil. To show the terms and conditions dialog, see the methods on GMSNavigationServices.

Allows subscription to road-snapped location updates.

If the user has not accepted the Google Navigation terms and conditions, this will be nil. To show the terms and conditions dialog, see the methods on GMSNavigationServices.

Allows you to simulate the device location.

The simulated location affects the position of the chevron on the map, the progress of turn-by-turn guidance, and the updates provided by the road-snapped location provider.

If the user has not accepted the Google Navigation terms and conditions, this will be nil. To show the terms and conditions dialog, see the methods on GMSNavigationServices.

The mode of the camera which determines its behavior when the navigationEnabled property is set to YES.

See GMSNavigationCameraMode for the available modes.

The camera perspective that will be used when following the device's location.

The navigationEnabled property must be set to YES and cameraMode must be set to GMSNavigationCameraModeFollowing for this perspective to take effect.

The travel mode which determines what type of routes will be fetched and the way that device course is determined.

In driving mode, device course is based on the direction of movement, while in cycling or walking mode the course is based on the compass direction the device is facing. Device course is represented by the direction of the device location marker and reported by the GMSRoadSnappedLocationProvider.

The lighting mode determines which color scheme should be used for rendering the map.

It is also used to determine the default colors of various interface elements.

Determines whether the speed limit should be displayed when guidance is active and speed limit data is available.

The default value is NO.

Specifies whether the speedometer icon is shown.

When enabled, a speedometer icon that indicates the vehicle speed appears in the bottom corner during guidance. When reliable speed limit data is available, the speed limit icon is also visible, and is attached with the speedometer icon. The speedometer icon can have different colors for text and background, depending on the speed alert severity.

If the recenter button is enabled, then the speed limit and the speedometer icon are temporarily hidden when the recenter button displays.

The rectangle that is covered by the navigation header.

Height is zero when the header is hidden.

The rectangle that is covered by the navigation footer.

Height is zero when the footer is hidden.

Specifies which route callout format (default, time, or distance) to use.

Customized zoom level during navigation.

Setting this value will override the default Navigation SDK zoom level when the camera is following device location (i.e. cameraMode equals GMSNavigationCameraModeFollowing). This can be set to GMSNavigationNoFollowingZoomLevel if no zoom level override should be used.

Sets the My Location provider for this map view.

Normally the My Location dot and accuracy circle for a map view are driven by the actual device location. By setting this property, the My Location dot and accuracy circle will be driven by the road-snapped location from the given location provider instead. To return to the normal behavior, set this property to nil.

This has no effect when navigationEnabled is on for this map view.