class
ActivityTracker
public static func == (lhs: ActivityTracker, rhs: ActivityTracker) -> Bool
Returns a Boolean value indicating whether two values are equal.
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
The model of the navigator whose status is being tracked.
speedBound
Upper speed limit in m/s, if exceeded in the Finished state of the navigator, the navigator is considered 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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
var stopChannel
A flag whose active state 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
A flag whose active state 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.
AlternativeRoutesProviderSettings
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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
var alternativeRoutesEnabled
Flag to enable/disable alternative route suggestion. By default, the alternate route suggestion is on.
var betterRouteEnabled
Flag to enable/disable suggestion of a better route. By default, better route suggestion is on.
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
The 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 feeding them into the given hasher.
hasher
The 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] = [])
Setting a set of attributes.
values
Set of “name”:“value” pairs for attributes being added.
attributesToRemove
List of property names to delete.
public func removeAttribute(name: String)
Removing an attribute.
name
Name of a property to delete.
public func getAttributeValue(name: String) -> AttributeValue
Getting 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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
public func setPosition(position: CameraPosition) throws
Set a new camera position.
position
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 indentation.
positionPoint
New position relative to the area of the screen bounded by the indents.
var projection
Projection.
var positionChannel
Getting the current camera position.
var position
Getting the current camera position.
var zoomRestrictionsChannel
Getting the current zoom level limits.
var zoomRestrictions
Getting the current zoom level limits.
var deviceDensityChannel
Getting the DPI ratio to the base DPI of the device.
var deviceDensity
Getting the DPI ratio to the base DPI of the device.
var sizeChannel
Getting the viewport size.
var size
Getting the viewport size.
var paddingChannel
Getting the current indentation from the edges of the screen.
var padding
Getting the current indentation from the edges of the screen.
var positionPointChannel
The screen point to which the camera position is anchored is set with the padding.
var positionPoint
The screen point to which the camera position is anchored is set with the padding.
var visibleArea
The intersection area between the camera's visibility pyramid and the map surface.
var visibleRectChannel
The volume rectangle of the visible area of the map.
var visibleRect
The volume rectangle of the visible area of the map.
var styleZoomToTiltRelationChannel
Getting the current function of the camera tilt angle dependence on the style zoom level.
var styleZoomToTiltRelation
Getting the current function of the camera tilt angle dependence on the style zoom level.
var maxTiltRestrictionChannel
Get the current function of the dependence of the maximum camera tilt angle on the style zoom level.
var maxTiltRestriction
Get the current function of the dependence of the maximum camera tilt angle on the style zoom level.
BoolRouteLongAttribute
A 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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
public func entry(point: RoutePoint) -> BoolRouteLongEntry?
The element in which the point falls.
public func entries(begin: RoutePoint,end: RoutePoint) -> [BoolRouteLongEntry]
Elements partially or completely covered by the segment [begin, end].
BufferedChannel
var value
Camera
Camera for triggering map movement and tracking settings.
public func move(moveController: CameraMoveController) -> Future<CameraAnimatedMoveResult>
Start moving the map.
public func move(position: CameraPosition,time: TimeInterval = 0.3,animationType: CameraAnimationType = CameraAnimationType.`default`) -> Future<CameraAnimatedMoveResult>
Starting an animated map movement using the built-in map movement controller.
position
Camera end position.
time
Time allocated for moving the map.
animationType
Type of animation when moving the camera.
public func processMovementAndStop()
Set the camera position according to the current time and stop the animated movement.
public func addFollowController(followController: FollowController)
Adding the follow controller.
followController
public func removeFollowController(followController: FollowController)
Removing the follow controller.
followController
public func setCustomFollowController(followController: CustomFollowController)
Adding the follow controller implemented on the platform.
followController
public func removeCustomFollowController()
Removing 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.
public convenience init(model: Model)
Navigation extension that warns you if you enter the coverage area of a traffic camera.
model
The model of the navigator whose status is being tracked.
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.
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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
public func entries(begin: RoutePoint,end: RoutePoint) -> [CameraRouteEntry]
Elements that fall within the segment [begin, end).
public func findNearBackward(point: RoutePoint) -> CameraRouteEntry?
Find the nearest element with position < = point.
public func findNearForward(point: RoutePoint) -> CameraRouteEntry?
Find the nearest element with position >= point.
CancelEvent
Cancellable
A 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 feeding them into the given hasher.
hasher
The 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.
A 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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
Circle
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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
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
Journaling 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
Create a constructor of standard and custom styles.
public func makeSearchManagerFactory() throws -> ISearchManagerFactory
Create a factory search engines for a directory.
public func makeSourceFactory() throws -> ISourceFactory
Create a factory of map data sources.
public func makeImageFactory() throws -> IImageFactory
Create a factory of images for map objects.
public func makeLocaleManager() throws -> LocaleManager
Create a manager of locale settings of an application.
public func makeRouteEditorFactory() throws -> IRouteEditorFactory
Create a factory of route editors.
public func makeRoadEventCardViewFactory(options: RoadEventCardViewOptions = .default) throws -> IRoadEventCardViewFactory
Create 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 feeding them into the given hasher.
hasher
The hasher to use when combining the components of this instance.
CreateRoadEventControl
CurrentLocationControl
Unit with the function of flyover to the current location.
public override func layoutSubviews()
DgisMapObject
DgisSource
The main interface of 2GIS data sources.
public static func createDgisSource(context: Context,workingMode: DgisSourceWorkingMode = DgisSourceWorkingMode.online) -> Source
Create a source that receives data from 2GIS servers or uses preloaded data.
public func setHighlighted(directoryObjectIds: [DgisObjectId],highlighted: Bool)
Setting or unsetting the object highlight.
directoryObjectIds
IDs of the objects being changed.
highlighted
Setting or removing a selection.
DirectMapControlBeginEvent
The 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
The event of direct map scaling. Direct map control events are described in DirectMapControlBeginEvent.
public convenience init(zoomDelta: Float,timestamp: TimeInterval,scalingCenter: ScreenPoint? = nil)
zoomDelta
The value by which the current zoom 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
The 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.
public static func == (lhs: DirectoryObject, rhs: DirectoryObject) -> 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 formattedAddress(type: FormattingType) -> FormattedAddress?
The string representation of the address formatted according to the specified length requirement.
var types
Object type. There can be several, for example, Sun City Mall is a branch of an organization and a building at the same time. The first type in this list is the primary type.
var title
Object title.
var titleAddition
Additional title information. Example: “(apt. 1-12)”
var subtitle
Object subheading.
var id
Stable numeric object ID.
var markerPosition
The point of the object where the marker should be placed.
var address
The address of the object as a set of components.
var attributes
Additional object attributes.
var contextAttributes
Contextual object's additional attributes.
var timeZoneOffset
The shift of the object's local time relative to UTC in seconds at the current moment.
var openingHours
The object's running time.
var contactInfos
The object's contacts.
var reviews
Reviews.
var parkingInfo
Additional parking information.
var workStatus
Operating status.
var levelId
Identifier of the floor on which the facility is located.
var buildingLevels
Information about the floor plans of the building.
var entrances
Information about entrances.
DoubleRouteAttribute
A container that describes a point attribute of the 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: DoubleRouteAttribute, rhs: DoubleRouteAttribute) -> 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 entries(begin: RoutePoint,end: RoutePoint) -> [DoubleRouteEntry]
Elements falling in the segment [begin, end).
public func findNearBackward(point: RoutePoint) -> DoubleRouteEntry?
Find the nearest element with position < = point.
public func findNearForward(point: RoutePoint) -> DoubleRouteEntry?
Find the nearest element with position >= point.
DynamicRouteInfoSettings
Settings for getting dynamic route data.
public static func == (lhs: DynamicRouteInfoSettings, rhs: DynamicRouteInfoSettings) -> 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.
Event
Base class for all events handled.
public static func == (lhs: Event, rhs: Event) -> 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.
ExceedSpeedLimitSettings
Settings of the detection of exceeding the speed limit.
public static func == (lhs: ExceedSpeedLimitSettings, rhs: ExceedSpeedLimitSettings) -> 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.
File
File ID.
public static func == (lhs: File, rhs: File) -> 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.
FloatRouteLongAttribute
A 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: FloatRouteLongAttribute, rhs: FloatRouteLongAttribute) -> 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 entry(point: RoutePoint) -> FloatRouteLongEntry?
The element in which the point falls.
public func entries(begin: RoutePoint,end: RoutePoint) -> [FloatRouteLongEntry]
Elements partially or completely covered by the segment [begin, end].
FollowController
A class that