Skip to main content

class

ActivityTracker​

Extends: Hashable
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.

Parameters

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

TimeInterval

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.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters

hasher

Hasher

Hasher to use when combining the components of this instance.

Properties

var stopChannel​

StatefulChannel<Bool>

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.

Extends: Hashable
public static func == (lhs: AlternativeRouteSelector, rhs: AlternativeRouteSelector) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Parameters

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.

Parameters

trafficRoute

Alternative route that must be selected as the current active route.

AlternativeRoutesProviderSettings​

Settings of searching for alternative routes and a better route.

Extends: Hashable
public static func == (lhs: AlternativeRoutesProviderSettings, rhs: AlternativeRoutesProviderSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters

hasher

Hasher

Hasher to use when combining the components of this instance.

Properties

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.

Extends: Hashable
public static func == (lhs: Attributes, rhs: Attributes) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters

hasher

Hasher

Hasher to use when combining the components of this instance.

public func setAttributeValue(
    name: String,
    value: AttributeValue
)

Setting an attribute.

Parameters

name

Property name.

value

Value.

public func setAttributeValues(
    values: [String: AttributeValue],
    attributesToRemove: [String] = []
)

Sets a set of attributes.

Parameters

values

String[ : ]

Set of “name”:“value” pairs for added properties.

attributesToRemove

List of property names to delete.

public func removeAttribute(
    name: String
)

Removes an attribute.

Parameters

name

Name of a property to delete.

public func getAttributeValue(
    name: String
) -> AttributeValue

Gets an attribute.

Parameters

name

Name of a property to retrieve.

Returns
AttributeValue
Properties

var attributeNames​

Retrieving a list of properties.

var changed​

Channel<[String]>

Gets a channel notifying about the change of the properties.

BaseCamera​

Camera.

Extends: Hashable
public static func == (lhs: BaseCamera, rhs: BaseCamera) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters

hasher

Hasher

Hasher to use when combining the components of this instance.

public func clone() -> BaseCamera

Creates a copy of the current camera.

Returns
BaseCamera
public func setPosition(
    position: CameraPosition
) throws

Sets a new camera position.
The call interrupts flyover and gesture handling, and resets the tracking mode.

Parameters

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.

Parameters

positionChange

public func setZoomRestrictions(
    zoomRestrictions: CameraZoomRestrictions
) throws

Sets a new range of zoom level limits.

Parameters

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.

Parameters

positionPoint

New position relative to the area of the screen bounded by the paddings.

Properties

var projection​

Projection.

var positionChannel​

StatefulChannel<CameraPosition>

Gets the current camera position.

var position​

Gets the current camera position.

var zoomRestrictionsChannel​

StatefulChannel<CameraZoomRestrictions>

Gets the current zoom level limits.

var zoomRestrictions​

Gets the current zoom level limits.

var deviceDensityChannel​

StatefulChannel<DeviceDensity>

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​

StatefulChannel<ScreenSize>

Gets the viewport size.

var size​

Gets the viewport size.

var paddingChannel​

StatefulChannel<Padding>

Gets the current padding from the edges of the screen.

var padding​

Gets the current padding from the edges of the screen.

var positionPointChannel​

StatefulChannel<CameraPositionPoint>

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​

StatefulChannel<GeoRect>

Volume rectangle of the visible area of the map.

var visibleRect​

Volume rectangle of the visible area of the map.

var maxTiltRestrictionChannel​

StatefulChannel<StyleZoomToTiltRelation?>

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.

Extends: FollowController
public convenience init(
    bearingSource: BearingSource,
    animationDuration: TimeInterval = 1,
    valueThreshold: Bearing = Bearing(value: 1)
)

Creates a controller following the map bearing.

Parameters

bearingSource

Source of bearing information.

animationDuration

TimeInterval

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.

Extends: Hashable
public static func == (lhs: BoolRouteLongAttribute, rhs: BoolRouteLongAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters

hasher

Hasher

Hasher to use when combining the components of this instance.

public func entry(
    point: RoutePoint
) -> BoolRouteLongEntry?

Element in which the point falls.

Parameters

point

Returns
BoolRouteLongEntry?
public func entries(
    begin: RoutePoint,
    end: RoutePoint
) -> [BoolRouteLongEntry]

Elements partially or completely covered by the [begin, end] segment.

Parameters

begin

end

Returns
BoolRouteLongEntry[]
Properties

var size​

Number of elements.

var isEmpty​

Elements missing.

var first​

First element.

var last​

Last element.

var entries​

All elements.

BufferedChannel​

Extends: Channel<Value>
Properties

var value​

Value?

Camera​

Camera for triggering map movement and tracking settings.

Extends: BaseCamera
Methods
public func move(
    moveController: CameraMoveController
) -> Future<CameraAnimatedMoveResult>
Parameters

moveController

Animated camera movement controller.

Returns
Future<>
public func move(
    position: CameraPosition,
    time: TimeInterval = 0.3,
    animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>
Parameters

position

Camera end position.

time

TimeInterval

Time allocated for moving the map.

animationType

Type of animation when moving the camera.

Returns
Future<>
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.

Parameters

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

TimeInterval

Time allocated for moving the map.

animationType

Type of animation when moving the camera.

Returns
Future<>
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.

Parameters

behaviour

public func addFollowController(
    followController: FollowController
)

Adds the follow controller.

Parameters

followController

public func removeFollowController(
    followController: FollowController
)

Removes the follow controller.

Parameters

followController

public func setCustomFollowController(
    followController: CustomFollowController
)

Adding the follow controller implemented on the platform.

Parameters

followController

public func removeCustomFollowController()

Removes the follow controller implemented on the platform.

func setPosition(point: GeoPoint, zoom: Zoom) throws
Parameters

point

zoom

func setPosition(point: GeoPoint) throws
Parameters

point

Properties

var stateChannel​

StatefulChannel<CameraState>

Obtaining the current status of the camera.

var state​

Obtaining the current status of the camera.

var behaviourChannel​

StatefulChannel<CameraBehaviourChange>

Camera tracking mode.

var behaviour​

Camera tracking mode.

CameraNotifier​

Warns you if you enter the coverage area of a traffic camera.

Extends: Hashable
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.

Parameters

model

Model of the navigator whose status is being tracked.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters

hasher

Hasher

Hasher to use when combining the components of this instance.

Properties

var cameraProgressChannel​

StatefulChannel<CameraProgressInfo?>

Progress of passing the traffic camera coverage area.

var cameraProgress​

Progress of passing the traffic camera coverage area.

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.

Extends: Hashable
public static func == (lhs: CameraRouteAttribute, rhs: CameraRouteAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by passing them to the given hasher.

Parameters

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.

Parameters

begin

end

Returns
CameraRouteEntry[]
public func findNearBackward(
    point: RoutePoint
) -> CameraRouteEntry?

Finds the nearest element with position < = point.
The operation complexity is log2(N), where N = size.

Parameters

point

Returns
CameraRouteEntry?
public func findNearForward(
    point: RoutePoint
) -> CameraRouteEntry?

Finds the nearest element with position < = point.
The operation complexity is log2(N), where N = size.

Parameters

point

Returns
CameraRouteEntry?
Properties

var size​

Number of elements.

var isEmpty​

Elements missing.

var first​

First element.

var last​

Last element.

var entries​

All elements.

CancelEvent​

Event of canceling the current action.

Extends: Event
public convenience init()

Cancellable​

Cancellation token for a running operation.

Implements: ICancellable
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.

Methods
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.

Parameters

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.

Methods
public func sink(
	receiveValue: @escaping (Value) -> Void
) -> Cancellable

Subscribe to a stream of values over time. The subscription never fails.

Returns
Cancellable

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.

Parameters

hasher

Hasher

Hasher to use when combining the components of this instance.

CheckableGroupedItem​

Single element from GroupCheckableItem.

Extends: Hashable
public static func == (lhs: CheckableGroupedItem, rhs: CheckableGroupedItem) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var text​

Gets a textual description of the element.

var values​

Gets the list of values used for filtering. Commonly, only one value is used.

var isChecked​

Gets the element state.

CheckableItem​

Basic representation of a checkable element from CheckableItemsGroup.

Extends: Hashable
public static func == (lhs: CheckableItem, rhs: CheckableItem) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var type​

Gets the type of the checkable element.

var filterType​

Gets a list of filters describing the current state of the widget. Can be used during creation of a search query.

CheckableItemsGroup​

Widget for presenting a group of selectable elements.

Extends: Widget
Properties

var items​

Gets the group of widget elements.

Checkbox​

Checkbox widget.

Extends: Widget
Properties

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.

Extends: SimpleMapObject
public convenience init(
    options: CircleOptions
) throws
Parameters

options

Methods
public func setPosition(
    position: GeoPoint
) throws

Sets the location of the circle center.

Parameters

position

public func setRadius(
    radius: Meter
) throws

Sets the circle radius.

Parameters

radius

Properties

var position​

Location of the center of a circle.

var radius​

Radius of a circle.

var color​

Circle fill color.

var strokeWidth​

Circle border line width.

var strokeColor​

Circle border color.

var dashedStrokeOptions​

ClusterObject​

Cluster of objects.

Extends: MapObject
Properties

var position​

Gets the cluster position on the map.

var objectCount​

Gets the number of markers in the cluster.

var objects​

Gets the list of markers in the cluster.

var geometryObject​

Obtains the geometric object of the cluster.

CompassControl​

Extends: UIControl
Methods
public override func layoutSubviews()
Properties

var intrinsicContentSize​

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.

Extends: Hashable
public static func == (lhs: CompassControlModel, rhs: C