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
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.
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 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 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 styleZoomToTiltRelationChannel
Gets the current function of the camera tilt angle dependence on the style zoom level.
var styleZoomToTiltRelation
Gets the current function of the camera tilt angle dependence on the style zoom level.
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.
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>
Starts moving the map.
Resets the current map tracking mode and interrupts gesture processing.
public func move(
position: CameraPosition,
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.
position
Camera end 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 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.
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()
Makes 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.
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 passing them to the given hasher.
hasher
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
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.
CreateRoadEventControl
CurrentLocationControl
Unit with the function of flyover to the current location.
public override func layoutSubviews()
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 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
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 passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func formattedAddress(
type: FormattingType
) -> FormattedAddress?
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 subtitle.
Can be an empty string if a subtitle is missing.
var id
Stable numeric object ID.
var markerPosition
Point of the object where the marker should be placed.
var address
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
Opening hours of the object.
var contactInfos
Contacts of the object.
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.
var tradeLicense
Data on the organization license.
DoubleRouteAttribute
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: 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 passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [DoubleRouteEntry]
Elements that fall within the [begin, end) range.
public func findNearBackward(
point: RoutePoint
) -> DoubleRouteEntry?
Finds the nearest element with position < = point.
The operation complexity is log2(N), where N = size.
public func findNearForward(
point: RoutePoint
) -> DoubleRouteEntry?
Finds the nearest element with position > = point.
The operation complexity is log2(N), where N = size.
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 passing them to the given hasher.
hasher
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 passing them to the given hasher.
hasher
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 passing them to the given hasher.
hasher
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 passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
FloatRouteLongAttribute
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 passing them to the given hasher.
hasher
Hasher to use when combining the components of this instance.
public func entry(
point: RoutePoint
) -> FloatRouteLongEntry?
Element in which the point falls.
public func entries(
begin: RoutePoint,
end: RoutePoint
) -> [FloatRouteLongEntry]
Elements partially or completely covered by the [begin, end] segment.
FollowController
Allows you to control the position of the camera and the geopositioning marker. All its methods implementations must be thread-safe. Most methods have trivial default implementations (so that FollowController, which is responsible for scaling, does not have to override coordinates() methods, etc.).
public static func == (lhs: FollowController, rhs: FollowController) -> 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 requestValues(
values: FollowValueOptionSet
)
Tells the FollowController which of the values it provides are in use. This frees up the resources involved in calculating unused values. The method can be called multiple times with different values, in which case the most recent value is relevant.
values
public func setClock(
clock: FollowControllerClock?
)
Passes the time source to the FollowController. The time values that are returned from next_timestamp() must be calculated relative to the values obtained from clock. This method is not called repeatedly to replace a previously set non-zero value with a different non-zero value.
public func setThresholds(
shiftMeters: Double,
rotation: Double
)
Thresholds for position shifts and rotation angles. Shorter offsets and rotations of smaller angles are not considered visually distinguishable.
public func updateValues()
Query to calculate all provided values. Immediately after calling this method, all values (coordinates(), satellite_bearing(), etc.) are considered relevant.
var availableValues
Set of value types that this FollowController can control. For example, one FollowController can only control coordinates, while another can only control map tilt.
var nextTimestampChannel
Channel that informs subscribers of the time of the next visible value change. The time of change of values not among those requested with request_values() may not be reported. The time values are interpreted relative to the source passed in set_clock().
var nextTimestamp
Channel that informs subscribers of the time of the next visible value change. The time of change of values not among those requested with request_values() may not be reported. The time values are interpreted relative to the source passed in set_clock().
var coordinates
Geographic coordinates.
var satelliteBearing
Direction of travel.
var magneticBearing
Direction to magnetic north.
var tilt
Map tilt.
var styleZoom
Style zoom level of the map.
var accuracy
Precision circle radius (meters).
FollowControllerClock
Clock used to measure time in FollowController.
public static func == (lhs: FollowControllerClock, rhs: FollowControllerClock) -> 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 now
FreeRoamSettings
public static func == (lhs: FreeRoamSettings, rhs: FreeRoamSettings) -> 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 onRoutePrefetchLength
Road graph tiles are loaded into HTTP cache during route guidance if they correspond to the route section from the current position to the specified distance. The default value is 5 km.
Tiles are not loaded into the HTTP cache if the parameter corresponds to a zero or negative distance.
var onRoutePrefetchRadiusMeters
When caching road graph tiles during route guidance, the tiles are loaded into HTTP cache if they are closer than the specified distance in meters from the route line. The default value is 1 km.
Tiles are not loaded into HTTP cache if the parameter corresponds to zero or negative distance.
var prefetchRadiusMeters
Road graph tiles are loaded into HTTP cache if they are closer than the specified distance in meters from the current position. The default value is 2 km.
Tiles are not loaded to HTTP cache if the parameter corresponds to zero or negative distance.
Future
public init(
subscriber: @escaping Subscriber,
canceller: @escaping Canceller = {}
)
subscriber
Creates a new subscription.
canceller
Releases all associated resources. It must be called at some point after the subscription has fired (e.g. in deinit).
public static func ==(lhs: Future<Value>, rhs: Future<Value>) -> Bool
Returns a Boolean value indicating whether two values are equal.
public func sink(
receiveValue: @escaping (Value) -> Void,
failure: @escaping (Error) -> Void
) -> Cancellable
Subscribes for a future value or an error.
Cancellable instance. Deallocation of the result will tear down the single value subscription.
static func makeReadyValue(_ value: Value) -> Future<Value>
Makes an immediately ready future value.
static func makeReadyError(message: String) -> Future<Value>
Makes an immediately ready future error.
message
Error message.