YMKMap
- Summary
- Instance methods
- cameraPosition(with:)
- cameraPosition(with:focus:)
- cameraPosition(with:focus:azimuth:)
- cameraPosition(with:focus:azimuth:tilt:)
- visibleRegion(with:)
- move(with:)
- move(with:animation:)
- move(with:animation:cameraCallback:)
- addInputListener(with:)
- removeInputListener(with:)
- addCameraListener(with:)
- removeCameraListener(with:)
- setMapLoadedListenerWith(_:)
- addTapListener(with:)
- removeTapListener(with:)
- deselectGeoObject()
- selectGeoObject(withSelectionMetaData:)
- addIndoorStateListener(with:)
- removeIndoorStateListener(with:)
- setMapStyleWithStyle(_:)
- setMapStyleWithId(_:style:)
- resetMapStyles()
- set2DMode(withEnable:)
- addObjectLayer(withLayerId:)
- projection()
- wipe()
- addTileLayer(withLayerId:layerOptions:createTileDataSource:)
- Properties
|
class YMKMap : NSObject |
The object that is used to interact with the map.
Summary
Instance methods
|
func cameraPosition(with geometry: YMKGeometry) -> YMKCameraPosition |
|
func cameraPosition(with geometry: YMKGeometry, |
|
func visibleRegion(with cameraPosition: YMKCameraPosition) -> YMKVisibleRegion |
|
func move(with cameraPosition: YMKCameraPosition) |
|
func move(with cameraPosition: YMKCameraPosition, animation: YMKAnimation?) |
|
func move(with cameraPosition: YMKCameraPosition, |
|
func addInputListener(with inputListener: any YMKMapInputListener) |
|
func removeInputListener(with inputListener: any YMKMapInputListener) |
|
func addCameraListener(with cameraListener: any YMKMapCameraListener) |
|
func removeCameraListener(with cameraListener: any YMKMapCameraListener) |
|
func setMapLoadedListenerWith(_ mapLoadedListener: (any YMKMapLoadedListener)?) |
|
func addTapListener(with tapListener: any YMKLayersGeoObjectTapListener) |
|
func removeTapListener(with tapListener: any YMKLayersGeoObjectTapListener) |
|
func deselectGeoObject() |
|
func selectGeoObject(withSelectionMetaData selectionMetaData: YMKGeoObjectSelectionMetadata) |
|
func addIndoorStateListener(with indoorStateListener: any YMKIndoorStateListener) |
|
func removeIndoorStateListener(with indoorStateListener: any YMKIndoorStateListener) |
|
func setMapStyleWithStyle(_ style: String) -> Bool |
|
func setMapStyleWithId(_ id: Int, style: String) -> Bool |
|
func resetMapStyles() |
|
func set2DMode(withEnable enable: Bool) |
|
func addObjectLayer(withLayerId layerId: String) -> YMKRootMapObjectCollection |
|
func projection() -> YMKProjection |
|
func wipe() |
|
func addTileLayer(withLayerId layerId: String, |
Properties
|
var cameraPosition: YMKCameraPosition { get } |
|
var visibleRegion: YMKVisibleRegion { get } |
|
var cameraBounds: YMKCameraBounds { get } |
|
var isNightModeEnabled: Bool { get set } |
|
var isZoomGesturesEnabled: Bool { get set } |
|
var isScrollGesturesEnabled: Bool { get set } |
|
var isTiltGesturesEnabled: Bool { get set } |
|
var isRotateGesturesEnabled: Bool { get set } |
|
var isFastTapEnabled: Bool { get set } |
|
var mapType: YMKMapType { get set } |
|
var mapObjects: YMKRootMapObjectCollection { get } |
|
var poiLimit: NSNumber? { get set } |
|
var isIndoorEnabled: Bool { get set } |
|
var mode: YMKMapMode { get set } |
|
var isHdModeEnabled: Bool { get set } |
|
var isAwesomeModelsEnabled: Bool { get set } |
|
var isValid: Bool { get } |
Instance methods
cameraPosition(with:)
|
func cameraPosition(with geometry: YMKGeometry) -> YMKCameraPosition |
Calculates a camera position that projects the specified geometry into the given { focusRect}, using the provided { azimuth} and {``` tilt} camera parameters.
If {``` focusRect} is not provided, the current focus rect is used (or the full view if no focus rect is set).
If {``` azimuth} is not provided, the current {``` cameraPosition.azimuth} is used.
If {``` tilt} is not provided, the current {``` cameraPosition.tilt} is used.
- returns: The computed camera position.cameraPosition(with:focus:)
|
func cameraPosition(with geometry: YMKGeometry, |
Calculates a camera position that projects the specified geometry into the given { focusRect}, using the provided { azimuth} and {``` tilt} camera parameters.
If {``` focusRect} is not provided, the current focus rect is used (or the full view if no focus rect is set).
If {``` azimuth} is not provided, the current {``` cameraPosition.azimuth} is used.
If {``` tilt} is not provided, the current {``` cameraPosition.tilt} is used.
- returns: The computed camera position.cameraPosition(with:focus:azimuth:)
|
func cameraPosition(with geometry: YMKGeometry, |
Calculates a camera position that projects the specified geometry into the given { focusRect}, using the provided { azimuth} and {``` tilt} camera parameters.
If {``` focusRect} is not provided, the current focus rect is used (or the full view if no focus rect is set).
If {``` azimuth} is not provided, the current {``` cameraPosition.azimuth} is used.
If {``` tilt} is not provided, the current {``` cameraPosition.tilt} is used.
- returns: The computed camera position.cameraPosition(with:focus:azimuth:tilt:)
|
func cameraPosition(with geometry: YMKGeometry, |
Calculates a camera position that projects the specified geometry into the given { focusRect}, using the provided { azimuth} and {``` tilt} camera parameters.
If {``` focusRect} is not provided, the current focus rect is used (or the full view if no focus rect is set).
If {``` azimuth} is not provided, the current {``` cameraPosition.azimuth} is used.
If {``` tilt} is not provided, the current {``` cameraPosition.tilt} is used.
- returns: The computed camera position.visibleRegion(with:)
|
func visibleRegion(with cameraPosition: YMKCameraPosition) -> YMKVisibleRegion |
|
Returns |
|
The map region that is visible from the given camera |
move(with:)
|
func move(with cameraPosition: YMKCameraPosition) |
Changes the camera position. Can cancel a previous unfinished movement.
null}, the camera position changes instantly. - see: mapkit.Animation for more details. - parameter: cameraCallback A function that receives a boolean indicating whether the camera action completed successfully. Invoked when: <ul> <li>The camera action is cancelled (for example, due to a new camera movement request), in which case { false} is passed.
|
Parameters |
|
|
animation |
Defines animation parameters. If { |
move(with:animation:)
|
func move(with cameraPosition: YMKCameraPosition, animation: YMKAnimation?) |
Changes the camera position. Can cancel a previous unfinished movement.
null}, the camera position changes instantly. - see: mapkit.Animation for more details. - parameter: cameraCallback A function that receives a boolean indicating whether the camera action completed successfully. Invoked when: <ul> <li>The camera action is cancelled (for example, due to a new camera movement request), in which case { false} is passed.
|
Parameters |
|
|
animation |
Defines animation parameters. If { |
move(with:animation:cameraCallback:)
|
func move(with cameraPosition: YMKCameraPosition, |
Changes the camera position. Can cancel a previous unfinished movement.
null}, the camera position changes instantly. - see: mapkit.Animation for more details. - parameter: cameraCallback A function that receives a boolean indicating whether the camera action completed successfully. Invoked when: <ul> <li>The camera action is cancelled (for example, due to a new camera movement request), in which case { false} is passed.
|
Parameters |
|
|
animation |
Defines animation parameters. If { |
addInputListener(with:)
|
func addInputListener(with inputListener: any YMKMapInputListener) |
Adds input listeners.
The class does not retain the object in the 'inputListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
removeInputListener(with:)
|
func removeInputListener(with inputListener: any YMKMapInputListener) |
Removes input listeners.
addCameraListener(with:)
|
func addCameraListener(with cameraListener: any YMKMapCameraListener) |
Adds camera listeners.
The class does not retain the object in the 'cameraListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
removeCameraListener(with:)
|
func removeCameraListener(with cameraListener: any YMKMapCameraListener) |
Removes camera listeners.
setMapLoadedListenerWith(_:)
|
func setMapLoadedListenerWith(_ mapLoadedListener: (any YMKMapLoadedListener)?) |
Sets a map loaded listener.
The class does not retain the object in the 'mapLoadedListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
addTapListener(with:)
|
func addTapListener(with tapListener: any YMKLayersGeoObjectTapListener) |
Adds a tap listener that is used to obtain brief geo object info.
The class does not retain the object in the 'tapListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
removeTapListener(with:)
|
func removeTapListener(with tapListener: any YMKLayersGeoObjectTapListener) |
Removes a tap listener that is used to obtain brief geo object info.
deselectGeoObject()
|
func deselectGeoObject() |
Resets the currently selected geo object.
selectGeoObject(withSelectionMetaData:)
|
func selectGeoObject(withSelectionMetaData selectionMetaData: YMKGeoObjectSelectionMetadata) |
Selects a geo object with the specified objectId in the specified layerId. If the object is not currently on the screen, it is selected anyway, but the user will not actually see that. You need to move the camera in addition to this call to be sure that the selected object is visible for the user. GeoObjectSelectionMetadata can be extracted from the geo object's metadata container when the user taps on a geo object.
addIndoorStateListener(with:)
|
func addIndoorStateListener(with indoorStateListener: any YMKIndoorStateListener) |
Subscribe to indoor state change events.
The class does not retain the object in the 'indoorStateListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.
removeIndoorStateListener(with:)
|
func removeIndoorStateListener(with indoorStateListener: any YMKIndoorStateListener) |
Unsubscribe from indoor state change events.
setMapStyleWithStyle(_:)
|
func setMapStyleWithStyle(_ style: String) -> Bool |
Applies JSON style transformations to the map. Same as setMapStyle(0, style). Affects VectorMap and Hybrid map types. Set to empty string to clear previous styling. Returns true if the style was successfully parsed, and false otherwise. If the returned value is false, the current map style remains unchanged.
setMapStyleWithId(_:style:)
|
func setMapStyleWithId(_ id: Int, style: String) -> Bool |
Applies JSON style transformations to the map. Replaces previous styling with the specified ID (if such exists). Stylings are applied in an ascending order. Affects VectorMap and Hybrid map types. Set to empty string to clear previous styling with the specified ID. Returns true if the style was successfully parsed, and false otherwise. If the returned value is false, the current map style remains unchanged.
resetMapStyles()
|
func resetMapStyles() |
Resets all JSON style transformations applied to the map.
set2DMode(withEnable:)
|
func set2DMode(withEnable enable: Bool) |
Forces the map to be flat. true - All loaded tiles start showing the "flatten out" animation; all new tiles do not start 3D animation. false - All tiles start showing the "rise up" animation.
addObjectLayer(withLayerId:)
|
func addObjectLayer(withLayerId layerId: String) -> YMKRootMapObjectCollection |
Creates a new independent map object collection linked to the specified layer ID. Sublayers will be added after corresponding sublayers of the topmost layer.
projection()
|
func projection() -> YMKProjection |
Provides map projection
wipe()
|
func wipe() |
Erases tiles, caches, etc. Does not trigger the next frame generation.
addTileLayer(withLayerId:layerOptions:createTileDataSource:)
|
func addTileLayer(withLayerId layerId: String, |
Adds tile layer.
Properties
cameraPosition
|
var cameraPosition: YMKCameraPosition { get } |
|
Returns |
|
Current camera position. Target position must be within |
visibleRegion
|
var visibleRegion: YMKVisibleRegion { get } |
|
Returns |
|
The map region that is currently visible. Region IS bounded |
cameraBounds
|
var cameraBounds: YMKCameraBounds { get } |
isNightModeEnabled
|
var isNightModeEnabled: Bool { get set } |
If enabled, night mode will reduce map brightness and improve contrast.
isZoomGesturesEnabled
|
var isZoomGesturesEnabled: Bool { get set } |
Enable/disable zoom gestures, for example: - pinch - double tap (zoom in) - tap with two fingers (zoom out)
isScrollGesturesEnabled
|
var isScrollGesturesEnabled: Bool { get set } |
Enable/disable scroll gestures, such as the pan gesture.
isTiltGesturesEnabled
|
var isTiltGesturesEnabled: Bool { get set } |
Enable/disable tilt gestures, such as parallel pan with two fingers.
isRotateGesturesEnabled
|
var isRotateGesturesEnabled: Bool { get set } |
Enable/disable rotation gestures, such as rotation with two fingers.
isFastTapEnabled
|
var isFastTapEnabled: Bool { get set } |
Removes the 300 ms delay in emitting a tap gesture. However, a double-tap will emit a tap gesture along with a double-tap.
mapType
|
var mapType: YMKMapType { get set } |
Sets the base map type.
mapObjects
|
var mapObjects: YMKRootMapObjectCollection { get } |
|
Returns |
|
List of map objects associated with the map. The layerId for |
logo
|
var logo: YMKLogo { get } |
Yandex logo object.
poiLimit
|
var poiLimit: NSNumber? { get set } |
Limits the number of visible basemap POIs.
Optional property, can be nil.
isIndoorEnabled
|
var isIndoorEnabled: Bool { get set } |
Enables/disables indoor plans on the map. Disabled by default.
mode
|
var mode: YMKMapMode { get set } |
Selects one of predefined map style modes optimized for particular use case(transit, driving, etc). Resets json styles set with setMapStyle. MapMode.Map by deafult.
isHdModeEnabled
|
var isHdModeEnabled: Bool { get set } |
Enables hd mode of displayed content
isAwesomeModelsEnabled
|
var isAwesomeModelsEnabled: Bool { get set } |
Enables rich textured 3d content on basemap.
isValid
|
var isValid: Bool { get } |
Tells if this object is valid or no. Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.