class
ActivityTracker
public static func == (lhs: ActivityTracker, rhs: ActivityTracker) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
platformContext: Context,
model: Model,
speedBound: Double = 4.2,
timeThreshold: TimeInterval = 20
)
Navigation extension that monitors user activity and gives a signal when the user has stopped using the navigator and it can be turned off.
platformContext
Context.
model
Model of the navigator status of which is being tracked.
speedBound
Upper limit of speed in m/s, if exceeded in the Finished state of the navigator, it is considered that the navigator is active, i.e. the movement continues.
timeThreshold
Time during which in the Finished state of the navigator the speed is tracked below the threshold for determining the inactive state of the navigator. If during this time the speed is less than the set threshold or there is no location and speed data, the navigator is considered inactive.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
var stopChannel
Flag the active state of which indicates that the navigator must be stopped. If in the Finished state the navigation stops, i.e. the movement stops or its speed becomes lower than the threshold value, and if this state persists for some time, the flag is set to true, otherwise it is set to false.
var stop
Flag the active state of which indicates that the navigator must be stopped. If in the Finished state the navigation stops, i.e. the movement stops or its speed becomes lower than the threshold value, and if this state persists for some time, the flag is set to true, otherwise it is set to false.
AlternativeRouteSelector
Alternative route selection.
public static func == (lhs: AlternativeRouteSelector, rhs: AlternativeRouteSelector) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
public func selectAlternativeRoute(
trafficRoute: TrafficRoute
)
Alternative route selection. If a passed route does not equal any of the current alternative routes, nothing happens. Otherwise, a corresponding alternative route becomes the current active route.
trafficRoute
Alternative route that must be selected as the current active route.
AlternativeRoutesProviderSettings
Settings of searching for alternative routes and a better route.
public static func == (lhs: AlternativeRoutesProviderSettings, rhs: AlternativeRoutesProviderSettings) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
var alternativeRoutesEnabled
Flag to enable/disable the suggestion of alternative routes. By default, suggestion of alternative routes is enabled.
var betterRouteEnabled
Flag to enable/disable the suggestion of a better route. By default, the better route suggestion is enabled.
var routeSearchDelay
Delay before searching for alternative routes when starting a trip on a route or after switching to another route. Must be at least 5 seconds. The default is 20 seconds.
var betterRouteTimeCostThreshold
Minimum difference in travel time between the original route and the alternate route at which the alternate route is considered a better route.
var betterRouteLengthThreshold
Minimum cumulative length of route edges that differ between the original route and the alternate route, at which the alternate route is considered the better route.
Attributes
Interface for managing map object attributes.
public static func == (lhs: Attributes, rhs: Attributes) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func setAttributeValue(
name: String,
value: AttributeValue
)
Setting an attribute.
public func setAttributeValues(
values: [String: AttributeValue],
attributesToRemove: [String] = []
)
Sets a set of attributes.
values
Set of “name”:“value” pairs for added properties.
attributesToRemove
List of property names to delete.
public func removeAttribute(
name: String
)
Removes an attribute.
name
Name of a property to delete.
public func getAttributeValue(
name: String
) -> AttributeValue
Gets an attribute.
BaseCamera
Camera.
public static func == (lhs: BaseCamera, rhs: BaseCamera) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func setPosition(
position: CameraPosition
) throws
Sets a new camera position.
The call interrupts flyover and gesture handling, and resets the tracking mode.
position
public func changePosition(
positionChange: CameraPositionChange
) throws
Changes only certain parameters of the camera position.
The call interrupts flyover and gesture handling and resets following changed parameters. If coordinates are changed, following the style scaling level and bearing is also reset.
positionChange
public func setZoomRestrictions(
zoomRestrictions: CameraZoomRestrictions
) throws
Sets a new range of zoom level limits.
zoomRestrictions
New range of zoom-level restrictions.
public func setPositionPoint(
positionPoint: CameraPositionPoint
) throws
Sets the new position relative to the area of the screen limited by the paddings.
positionPoint
New position relative to the area of the screen bounded by the paddings.
var projection
Projection.
var positionChannel
Gets the current camera position.
var position
Gets the current camera position.
var zoomRestrictionsChannel
Gets the current zoom level limits.
var zoomRestrictions
Gets the current zoom level limits.
var deviceDensityChannel
Gets the DPI ratio to the base DPI of the device.
var deviceDensity
Gets the DPI ratio to the base DPI of the device.
var sizeChannel
Gets the viewport size.
var size
Gets the viewport size.
var paddingChannel
Gets the current padding from the edges of the screen.
var padding
Gets the current padding from the edges of the screen.
var positionPointChannel
Screen point to which the camera position is anchored is set with the padding.
var positionPoint
Screen point to which the camera position is anchored is set with the padding.
var visibleArea
Intersection area between the camera's visibility pyramid and the map surface.
var visibleRectChannel
Volume rectangle of the visible area of the map.
var visibleRect
Volume rectangle of the visible area of the map.
var maxTiltRestrictionChannel
Gets the current function of the dependence of the maximum camera tilt angle on the style zoom level.
var maxTiltRestriction
Gets the current function of the dependence of the maximum camera tilt angle on the style zoom level.
BearingFollowController
Controller following the map bearing.
public convenience init(
bearingSource: BearingSource,
animationDuration: TimeInterval = 1,
valueThreshold: Bearing = Bearing(value: 1)
)
Creates a controller following the map bearing.
bearingSource
Source of bearing information.
animationDuration
Non-negative duration of changing the actual bearing.
valueThreshold
Non-negative threshold of changing the actual bearing taken into account.
BoolRouteLongAttribute
Container that stores an extended route attribute. Each element is stored as a pair consisting of a point and an attribute element value. The action of the attribute starts at the given point and ends at the next point, starting from which the action of the attribute of the next element begins.
public static func == (lhs: BoolRouteLongAttribute, rhs: BoolRouteLongAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> BoolRouteLongEntry?
Element in which the point falls.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [BoolRouteLongEntry]
Elements partially or completely covered by the [begin, end] segment.
BufferedChannel
var value
Camera
Camera for triggering map movement and tracking settings.
public func move(
moveController: CameraMoveController
) -> Future<CameraAnimatedMoveResult>
public func move(
position: CameraPosition,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>
position
Camera end position.
time
Time allocated for moving the map.
animationType
Type of animation when moving the camera.
public func move(
point: GeoPoint,
zoom: Zoom,
tilt: Tilt?,
bearing: Bearing,
time: TimeInterval = 0.3,
animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>
Starts an animated map move using the built-in map move controller.
Resets the current map tracking mode and interrupts gesture processing.
point
Point of the final camera position.
zoom
Scaling level in the final camera position.
tilt
Tilt in the final camera position or an empty value if you need to use a value from the FollowController or the current value depending on the active tracking mode.
bearing
Bearing in the final camera position.
time
Time allocated for moving the map.
animationType
Type of animation when moving the camera.
public func processMovementAndStop()
Sets the camera position according to the current time and stopping the animated movement.
The call interrupts the camera flyover and gesture processing and resets the tracking mode.
public func setBehaviour(
behaviour: CameraBehaviour
)
Switch of the camera tracking mode. If a new mode is more restricted then the current one, the call will interrupt the flyover and gesture handling.
behaviour
public func addFollowController(
followController: FollowController
)
Adds the follow controller.
followController
public func removeFollowController(
followController: FollowController
)
Removes the follow controller.
followController
public func setCustomFollowController(
followController: CustomFollowController
)
Adding the follow controller implemented on the platform.
followController
public func removeCustomFollowController()
Removes the follow controller implemented on the platform.
CameraNotifier
Warns you if you enter the coverage area of a traffic camera.
public static func == (lhs: CameraNotifier, rhs: CameraNotifier) -> Bool
Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .
public convenience init(
model: Model
)
Navigation extension that warns you if you enter the coverage area of a traffic camera.
model
Model of the navigator whose status is being tracked.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
CameraRouteAttribute
Container that describes a point attribute of a route. Each item is stored as a point on the route, in which the item is located, and the value of the item itself.
public static func == (lhs: CameraRouteAttribute, rhs: CameraRouteAttribute) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [CameraRouteEntry]
Elements that fall within the [begin, end) range.
public func findNearBackward(
point: RoutePoint
) -> CameraRouteEntry?
Finds the nearest element with position < = point.
The operation complexity is log2(N), where N = size.
public func findNearForward(
point: RoutePoint
) -> CameraRouteEntry?
Finds the nearest element with position < = point.
The operation complexity is log2(N), where N = size.
CancelEvent
Cancellable
Cancellation token for a running operation.
public init(
cancel: @escaping () -> Void,
release: @escaping () -> Void = {}
)
public convenience init()
Make a cancellation token that cancels nothing.
public static func ==(lhs: Cancellable, rhs: Cancellable) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func cancel()
May be called any number of times from any queue.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
Channel
public static func ==(lhs: Channel<Value>, rhs: Channel<Value>) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func sink(
receiveValue: @escaping (Value) -> Void
) -> Cancellable
Subscribe to a stream of values over time. The subscription never fails.
Cancellable instance. Deallocation of the result will tear down the subscription stream.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
CheckableGroupedItem
Single element from GroupCheckableItem.
public static func == (lhs: CheckableGroupedItem, rhs: CheckableGroupedItem) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
CheckableItem
Basic representation of a checkable element from CheckableItemsGroup.
public static func == (lhs: CheckableItem, rhs: CheckableItem) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
CheckableItemsGroup
Widget for presenting a group of selectable elements.
var items
Gets the group of widget elements.
Checkbox
Checkbox widget.
var filterType
Gets the filter type presented by the widget.
var checkedText
Gets the caption of the selected checkbox.
var uncheckedText
Gets the caption of the unselected checkbox.
var values
Gets the list of values used for filtering. Commonly, only one value is used.
var isChecked
Gets the widget state.
Circle
Circle.
public func setPosition(
position: GeoPoint
) throws
Sets the location of the circle center.
position
ClusterObject
Cluster of objects.
CompassControl
public override func layoutSubviews()
CompassControlModel
Model of the compass control. The control consists of a compass button that, when clicked, causes the map camera to change its angle in the direction of north. If the map camera is facing the north, the control must be hidden. Thread-safe.
public static func == (lhs: CompassControlModel, rhs: CompassControlModel) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func onClicked()
CompassViewModel
ViewModel for the compass UI control.
public func onClicked()
ComplexGeometry
Complex geometry, contains a set of simple or complex geometries.
var elements
Container
Central object for accessing iOS Mobile SDK features.
public convenience init(
apiKeyOptions: ApiKeyOptions = .default,
logOptions: LogOptions = .default,
httpClientForRequest: IHTTPClient? = nil,
httpOptions: HTTPOptions = .default,
positioningServices: IPositioningServicesFactory = PlatformPositioningServicesFactory(),
batteryOptions: BatteryOptions = .default,
personalDataCollectionOptions: PersonalDataCollectionOptions = .default,
localizationOptions: LocalizationOptions = .default,
audioOptions: AudioOptions = .default,
vendorConfigFile: File? = nil
)
Container builder.
apiKeyOptions
Key settings for accessing 2GIS services.
logOptions
Logging settings.
httpClientForRequest
Network client for sending HTTP requests.
httpOptions
HTTP client settings (such as caching).
positioningServices
Geo-positioning services.
batteryOptions
personalDataCollectionOptions
Data collection service settings.
localizationOptions
Application localization settings.
audioOptions
Sound settings.
vendorConfigFile
Overrides settings for working in an offline environment.
public func makeMapFactory(
options: MapOptions
) throws -> IMapFactory
options
Initial map properties. Specify .default to quickly create an online map looking at Moscow, with a fixed inaccurate PPI (not matching the current device).
public func makeStyleFactory() throws -> IStyleFactory
Creates a constructor of standard and custom styles.
public func makeSearchManagerFactory() throws -> ISearchManagerFactory
Creates a factory search engines for a directory.
public func makeSourceFactory() throws -> ISourceFactory
Creates a factory of map data sources.
public func makeImageFactory() throws -> IImageFactory
Creates a factory of images for map objects.
public func makeLocaleManager() throws -> LocaleManager
Creates a manager of locale settings of an application.
public func makeRouteEditorFactory() throws -> IRouteEditorFactory
Creates a factory of route editors.
public func makeRoadEventCardViewFactory(options: RoadEventCardViewOptions = .default) throws -> IRoadEventCardViewFactory
Creates a factory of a road event card.
var context
Root opaque SDK object container. Used as an argument to the SDK API.
var markerViewFactory
UIView marker factory for map.
var locationService
Current ILocationService implementation used within the SDK and working via ILocationProvider.
let audioSettings
Sound settings.
let httpOptions
HTTP client settings.
let batteryOptions
Battery tracking settings.
let localizationOptions
Application localization settings.
Context
Context - the environment required for the SDK to work.
public static func == (lhs: Context, rhs: Context) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func hash(into hasher: inout Hasher)
Hashes the essential components of this value by passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
CoordinatesFollowController
Controller of following the map position coordinates.
public convenience init(
animationDuration: TimeInterval = 1,
valueThreshold: Meter = Meter(value: 0.10000000149011612)
)
Creates a controller following the camera position coordinates.
animationDuration
Duration of changing the actual position.
valueThreshold
Non-negative threshold of the actual position change taken into account.
CreateRoadEventControl
CurrentLocationControl
Unit with the function of flyover to the current location.
public override func layoutSubviews()
CurrentLocationViewModel
ViewModel for the UI control of the current location.
public func onClicked()
DgisMapObject
2GIS map object.
Information about an object can be obtained in the directory.
var id
Stable numeric object ID.
DgisSource
Main interface of 2GIS data sources.
public static func createDgisSource(
context: Context,
workingMode: DgisSourceWorkingMode = DgisSourceWorkingMode.online
) -> Source
Creates a source that obtains data from 2GIS servers or uses preloaded data.
public func setHighlighted(
directoryObjectIds: [DgisObjectId],
highlighted: Bool
)
Sets or removes object highlighting.
The method adds the “selected” attribute to the object, which can be used in styles.
directoryObjectIds
IDs of the objects being changed.
highlighted
Sets or removes a selection.
DirectMapControlBeginEvent
Event to start direct control of the map. Tells the map to process direct map control events. Direct control events only work from DirectMapControlBeginEvent to DirectMapControlEndEvent. After the sequence of direct control events is complete, kinematics can start. Kinematics uses the occurrence time of the event, so it is better to use the time received from the system rather than fill in the value during processing. For now, kinematics only work for moving the map, but not for rotating and zooming.
public convenience init()
DirectMapControlEndEvent
Event of ending direct map control. Ends direct map control that was started after receiving the DirectMapControlBeginEvent event. Direct map control events are described in DirectMapControlBeginEvent.
public convenience init(
timestamp: TimeInterval
)
timestamp
DirectMapRotationEvent
Direct map rotation event. The events of direct map control are described in DirectMapControlBeginEvent.
public convenience init(
bearingDelta: Bearing,
timestamp: TimeInterval,
rotationCenter: ScreenPoint? = nil
)
bearingDelta
Change of the map rotation angle, in degrees. Positive values correspond to the direction of rotation counterclockwise.
timestamp
Time of the system event generation.
rotationCenter
Point on the screen relative to which the map rotates. If not set, rotation is done relative to the map position point.
DirectMapScalingEvent
Event of direct map scaling. Direct map control events are described in DirectMapControlBeginEvent.
public convenience init(
zoomDelta: Float,
timestamp: TimeInterval,
scalingCenter: ScreenPoint? = nil
)
zoomDelta
Value by which the current scale value will change.
timestamp
Time of the system event generation.
scalingCenter
Point on the screen relative to which the map scales. If not set, scaling is done relative to the map position point.
DirectMapShiftEvent
Direct map shift event. Direct map control events are described in DirectMapControlBeginEvent.
public convenience init(
screenShift: ScreenShift,
shiftedPoint: ScreenPoint,
timestamp: TimeInterval
)
screenShift
Change in the screen position of the map relative to the previous one, in pixels.
shiftedPoint
Center point from which the map is shifted.
timestamp
Time of the system event generation.
DirectMapTiltEvent
Event of direct camera tilt. The events of direct map control are described in DirectMapControlBeginEvent.
public convenience init(
delta: Float,
timestamp: TimeInterval
)
delta
Tilt angle change in degrees.
timestamp
Time of the system event generation.
var delta
Tilt angle change in degrees.
DirectoryObject
Directory object.