struct
Address
Address as a set of individual components.
public init(
drillDown: [AddressAdmDiv],
components: [AddressComponent],
buildingName: String?,
postCode: String?,
buildingCode: String?,
fiasCode: String?,
addressComment: String?
)
Set of administrative division objects in which the object being described is located.
Complete address of an object may contain several separate address components.
Name of the building.
ZIP code.
The unique ZIP code of the building.
FIAS code of the building.
Address comment. Example: “office 301; floor 9”.
AddressAdmDiv
Administrative unit object.
AddressLocation
Applies to components that are hard to describe with a specific address.
Verbal description of the location of a building.
AddressNumber
Some localities designate only the house number, without the street (e.g., Krasnoobsk).
AddressStreet
Normal address, there is a street and house number.
Anchor
Image anchor point (0, 0) - upper left corner, (1, 1) - lower right corner.
public init(
x: Float = 0.5,
y: Float = 0.5
)
ApartmentRange
Range of apartments.
Range start/Stored value. Currently only numeric values are supported, apartments with suffixes are not yet available in the data.
End of range. If absent, the range consists of a single start value. Otherwise it is an arithmetic progression from start to end in steps of 1.
ApiKeyOptions
Key settings for working with 2GIS SDK.
Attribute
Additional attribute. Example: { tag: “hotel_room_internet”, name: “Free internet in the rooms” }.
AudioOptions
Sound settings.
public init(muteOtherSounds: Bool, audioVolume: AudioVolume)
Default settings. Mutes the sound of other applications and maximizes the playback volume.
AuthorInfo
Information about the author of the event or photo.
Content author category.
String containing the name of the user who added the event or photo.
BatteryOptions
Battery condition monitoring settings. Used to configure the battery condition monitoring service needed to optimize power consumption when the charge level is low or to activate power saving mode.
public init(lowBatteryThreshold: Int, delegate: IBatteryManagerDelegate?)
Percentage of battery charge starting at and below which the charge is considered low. When the battery charge is low, aggressive power saving tools may be activated and warnings may be displayed. Value range: 0...100.
Delegate of the battery monitoring service. Required to control turning on and off the battery status monitoring (see UIDevice.isBatteryMonitoringEnabled), which allows you to automatically enable power optimization.
Default settings. The low battery limit is 15%. Battery status monitoring is disabled. Power optimization is not automatically enabled.
Bearing
Angle between the direction to one object and another object or between the direction to the object and north. The angle is counted clockwise. The value range is [0°, 360°].
public init(floatLiteral value: Double)
Creates an instance initialized to the specified floating-point value.
Value to create.
BetterRouteInfo
Information on available alternative route.
public init(
trafficRoute: TrafficRoute,
startPoint: RoutePoint
)
Alternative route.
Point on the alternative route from which traffic starts if you switch to this route.
BicycleBriefRouteInfo
Basic cycling route information.
BicycleInstructionCrossroad
Description of maneuvers when passing through an intersection or crosswalk.
public init(
landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.`none`,
maneuvers: [BicycleInstructionCrossroadManeuver]
)
Landmark.
Chain of sequential maneuvers.
BicycleInstructionCrossroadManeuver
public init(
direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.straight,
turnAngle: Int32 = 0
)
Direction of travel.
Turning angle in degrees [-180, 180].
BicycleInstructionFinish
End of the cycling part of the route.
public init()
BicycleInstructionStart
The beginning of the cycling part of the route.
public init()
BicycleRouteSearchOptions
Bicycle route search options.
public init(
avoidCarRoads: Bool = false,
avoidStairways: Bool = false,
avoidUnderpassesAndOverpasses: Bool = false,
excludedAreas: [ExcludedArea] = []
)
Avoid roads.
Avoid stairs.
Avoid underpasses and overpasses.
Excluded areas (not more than 25).
BoolRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: Bool
)
Borders
Describes a continuous set of sorted values.
Defines snapping to the value multiple of this number.
Indication of using the logarithmic scale.
Value by which filtering is done.
Lower bound of the values set.
Upper bound of the values set.
Currently set minimum value.
Currently set maximum value.
BriefRoadEvent
public init(
id: UInt64 = 0,
eventType: RoadEventType = RoadEventType.other,
lanes: LaneOptionSet
)
BriefRouteInfo
Basic route information.
public init(
duration: TimeInterval,
extraInfo: BriefExtraRouteInfo
)
Time of travel along the route.
Additional route information for a specific vehicle type.
BriefRouteInfoSearchPoints
Points to query for basic route information search.
public init(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint
)
Starting point of the route.
Finish point of the route.
BuildingId
BuildingInfo
Information about building.
public init(
buildingName: String? = nil,
purposeName: String? = nil,
purposeCode: PurposeCode? = nil,
buildingLevels: BuildingLevels? = nil
)
Name of the building.
Description of the purpose of the building.
Code of the purpose of the building.
Information about floor plans of the building.
BuildingLevels
Information about the floor plans of the building.
public init(
defaultLevelId: LevelId,
levels: [LevelInfo]
)
Default floor plan identifier.
All floor plans of the building.
CalloutMapPosition
Route bubble position.
public init(
mapId: MapId,
calloutPosition: GeoPoint?,
routePoint: RoutePoint?
)
Identifier of the map for which the position is given.
Position on the map.
Lane bubble position on the route.
CameraBehaviour
Camera tracking mode.
public init(
position: FollowPosition?,
tilt: FollowTilt = FollowTilt.off
)
CameraBehaviourChange
Changes tracking mode.
public init(
newBehaviour: CameraBehaviour,
changeReason: CameraBehaviourChangeReason
)
New tracking mode.
Reason for changing tracking mode.
CameraPosition
Camera position.
Terrain point that is located at the camera position point (see ICamera::position_point()).
Zoom level. 0 is the entire world inscribed in a square of 256x256 logical pixels (see LogicalPixel).
Tilt angle of the gaze direction vertically.
0 is nadir (vertically downward), maximum value is 60 degrees.
Angle of rotation of the view direction horizontally relative to the north direction. Counted clockwise, in degrees.
CameraPositionChange
Changing specific parameters of camera position.
CameraPositionPoint
Relative screen position of the point to which the camera is linked.
public init(
x: Float = 0.5,
y: Float = 0.5
)
CameraProgressInfo
Information about the progress of the camera zone.
public init(
camera: RouteCamera,
position: RoutePoint,
progress: Float = 0
)
Camera for the area for which progress is being tracked.
Camera position on the route.
Progress of the camera area, [0, 1].
CameraPurposeOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Recording of exceeding the speed limit.
Recording of exceeding the average speed on the section.
Recording of movement on the dedicated lane for public transport.
Recording of crossing the solid line of road markings, driving on the side of the road.
Recording of passing at the forbidden signal of traffic lights.
Recording of driving over the stop line, driving without stopping the stop sign, driving to the intersection during a jam.
Recording driving in the oncoming lane.
Recording failure to give priority to pedestrians.
Recording of violation of lane rotation at the intersection.
Recording of violation of prohibition of stopping.
Fake item.
Platon system camera, truck restriction control camera.
CameraRouteEntry
Route element - a point and a value in it.
CameraZoomRestrictions
Allowed range of zoom level variation.
CarBriefRouteInfo
Basic information about the automobile route.
public init(
length: RouteDistance,
landmark: String,
trafficSpeed: CarBriefRouteInfoTrafficSpeed
)
Route length.
Landmark.
Travel speed.
CarInstructionCrossroad
Description of maneuvers at the intersection.
public init(
direction: CarInstructionCrossroadDirection = CarInstructionCrossroadDirection.straight,
turnAngle: Int32 = 0,
landmark: CarInstructionCrossroadLandmark = CarInstructionCrossroadLandmark.`none`,
exitName: String
)
Direction of traffic at the intersection.
Turning angle in degrees [-180, 180].
Landmark.
Exit name.
CarInstructionFinish
End of the automobile part of the route.
public init()
CarInstructionRoundabout
Description of maneuvers at a traffic circle intersection.
public init(
type: CarInstructionRoundaboutType = CarInstructionRoundaboutType.entry,
turnAngle: Int32 = 0,
exitNumber: UInt32 = 0,
exitName: String
)
Type of instruction.
Turning angle in degrees [-180, 180].
Exit number - [1, inf] or 0 if the exit number is unknown.
Exit name.
CarInstructionStart
Start of the automobile part of the route.
public init()
CarInstructionUTurn
U-turn on the road (not at an intersection).
U-turn at an intersection is described by the Crossroad instruction.
Exit name.
CarRouteSearchOptions
Route search parameters in a passenger car.
public init(
avoidTollRoads: Bool = false,
avoidUnpavedRoads: Bool = false,
avoidFerries: Bool = true,
avoidLockedRoads: Bool = true,
routeSearchType: RouteSearchType = RouteSearchType.jam,
excludedAreas: [ExcludedArea] = []
)
Avoid toll roads.
Avoid unpaved roads.
Avoid ferry crossings.
Avoid closed roads. If true, the route search will not take into account road closures. If false is set, the route can be created through roadblocks if you cannot build a route without passing through roadblocks.
Route search type.
Excluded areas (not more than 25).
CircleOptions
Parameters for creating a geometric map object of the Circle type.
public init(
position: GeoPoint,
radius: Meter,
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value: 0),
strokeColor: Color = Color(),
visible: Bool = true,
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
levelId: LevelId? = nil
)
Geographic position.
Radius in meters.
Fill color.
Circle border line width.
Color of the circle boundary line.
Visibility flag.
User data. (not used inside SDK, only for API users).
Object drawing level.
Binding to the floor plan of the building.
ClusterOptions
Cluster marker parameters.
public init(
attributes: [String: AttributeValue],
userData: Any = ()
)
Cluster attributes.
User data returned to IClusterObject.
Color
Color.
init(
red: CGFloat,
green: CGFloat,
blue: CGFloat,
alpha: CGFloat
)
ContactInfo
Way to contact the organization.
DashedPolylineOptions
Parameters of the dotted polyline.
public init(
dashLength: LogicalPixel = LogicalPixel(value: 5),
dashSpaceLength: LogicalPixel = LogicalPixel(value: 2)
)
DayTime
Time moment within a day.
public static func < (lhs: DayTime, rhs: DayTime) -> Bool
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
DeviceDensity
Multiplier that is calculated as the ratio of DPI to the base DPI of the device.
Must be positive.
public init(
value: Float = 0
)
DevicePpi
Resolution of the device display, in pixels per inch.
Must be positive.
public init(
value: Float = 0
)
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
The value to create.
PPI of the head unit screen. For example, for a smartphone connected to CarPlay, this is the PPI of the smartphone screen. The value is nil if the current device has an unknown PPI (unsupported device, e.g. from future). In such cases, you need to set the PPI yourself using the entry in Map.devicePpi.
This PPI is used by default in cases where it was not possible to automatically determine from the device model. See `.autodetected'.
DgisObjectId
DirectoryFilter
Filters for the directory.
public init(
workTime: WorkTimeFilter?,
dynamic: [DynamicFilter]
)
DoubleRouteEntry
Route element - a point and a value in it.
DynamicRouteInfo
public init(
roadEvents: RoadEventRouteAttribute,
traffic: Traffic
)
Elevation
Non-negative elevation of the point above the surface, in meters.
public init(
value: Float = 0
)
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Value to create.
EntranceGeometry
Geometries for displaying the entrance on the map.
public init(
entrancePoints: [GeoPoint],
entrancePolylines: [[GeoPoint]]
)
Entrance location.
Geometries for arrows pointing to the entrance.
EntranceInfo
Information about the entrance to the building.
public init(
id: DgisObjectId,
buildingNumber: String?,
porchName: String?,
porchNumber: String?,
apartmentRanges: [ApartmentRange],
geometry: EntranceGeometry?
)
Input object ID.
Number of the house to which the entrance belongs.
Non-empty entrance name. Filled in for entrances only. Can take values of the entrance name (e.g. "Entrance 1 ") or building number if the entrance has its own address.
Non-empty entrance number. Filled in for entrances only. Can take values of entrance number (e.g. "1 ") or building number if the entrance has its own address.
Apartment numbers pertaining to the entryway.
Geometries for displaying the entrance on the map.
ExcludedArea
Excluded area to be avoided when building a route.
public init(
type: ExcludedAreaType = ExcludedAreaType.point,
severity: ExcludedAreaSeverity = ExcludedAreaSeverity.soft,
extent: RouteDistance,
points: [GeoPoint]
)
Type of the excluded area.
Priority of area exclusion.
Size of the excluded area (not more than 25 km).
Coordinates of the points of the excluded area (not more than 500).
FlagFilter
Flag filter.
FloatRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: Float
)
FloorInfo
Information about the floor plan for the marker - element of the search output.
FollowPosition
Tracking settings for direction, tilt, and zoom level.
public init(
bearing: FollowBearing = FollowBearing.off,
styleZoom: FollowStyleZoom = FollowStyleZoom.off
)
FollowValueOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
FormattedAddress
A human-readable representation of the address.
Address from a drill-down. Example: “Novosibirsk, Kirovsky district”.
Address inside a settlement. Example: “Nikolaeva str., 11”.
Address comment. Example: “office 301; floor 9”.
Postal code of the object with a building code, if any. Example: “630088”, “630007/XBVJF8”.
GeoPoint
Point in a spherical coordinate system that, together with a geodetic coordinate system (e.g., WGS84), points to a point on the Earth's surface. This structure is not bound to a specific geodetic coordinate system. But this module contains free functions that operate with this structure already in a specific coordinate system (see the documentation to the functions).
init(latitude: CLLocationDegrees, longitude: CLLocationDegrees)
func bearing(point: GeoPoint) -> Bearing
Calculates the bearing (the angle between the geographic north direction and the direction of movement, counted clockwise) between two points.
func distance(point: GeoPoint) -> Meter
Calculates the minimum distance (along a great circle) between two points.
GeoPointRouteEntry
Route element - a point and a value in it.
GeoPointWithElevation
Point in a geographic coordinate system (latitude, longitude, elevation).
Elevation is defined in meters above the surface, not above the sea level.
public init(
latitude: Latitude,
longitude: Longitude,
elevation: Elevation = Elevation(value: 0)
)
init(
latitude: CLLocationDegrees,
longitude: CLLocationDegrees,
elevation: CLLocationDistance
)
init(
coordinate: CLLocationCoordinate2D,
elevation: CLLocationDistance
)
func bearing(point: GeoPoint) -> Bearing
Calculates the bearing (the angle between the geographic north direction and the direction of movement, counted clockwise) for the projection of a point on the map and for a given point.
func distance(point: GeoPoint) -> Meter
Calculates the minimum distance (along a great circle) between two points.
func move(bearing: Bearing, meter: Meter) -> GeoPointWithElevation
Calculates the point obtained by moving the source point in the specified direction by the specified distance.
GeoRect
Rectangular area in a spherical coordinate system (e.g. WGS84). This structure is not tied to a specific geodetic coordinate system.
func contains(
point: GeoPoint
) -> Bool
Whether the rectangle contains the point. Points on the border are also considered to belong to the rectangle.
func intersects(
rect2: GeoRect
) -> Bool
Whether the rectangles intersect, i.e. have common points. The rectangles with common points located only on the boundary are also considered intersecting.
Southwest point, bottom left border of rectangle.
Northeast point, top right of rectangle.
Checks rectangle for correctness.
Checks the rectangle for degeneracy. If the points in the rectangle are equal, the rectangle is degenerate to a point. A degenerate rectangle is a correct rectangle. An incorrect rectangle is not degenerate.
GradientPolylineOptions
Parameters of the gradient polyline.
public init(
borderWidth: LogicalPixel = LogicalPixel(value: 0),
secondBorderWidth: LogicalPixel = LogicalPixel(value: 0),
gradientLength: LogicalPixel = LogicalPixel(value: 1),
borderColor: Color = Color(),
secondBorderColor: Color = Color(),
colors: [Color],
colorIndices: Data
)
Line border width.
Width of the second line border.
Gradient line length.
Outline color.
Color of the second outline.
Gradient polyline color palette.
Gradient polyline color indexes. The number of indexes must be 1 less than the number of polyline points.
HttpHeader
HTTPOptions
Keys for accessing 2GIS services.
public init(
timeout: TimeInterval,
cacheOptions: CacheOptions?
)
Network protocol wait time. Defaults to 15 seconds.
Caching mode. If nil, no cache is used. The default is to use the disk cache in the user's cache directory (NSCachesDirectory).
Default settings. Maximum cache size: 300 MB.
HttpRequest
Structure for presenting an HTTP request.
public init(
url: String,
method: HttpMethod = HttpMethod.gET,
headers: [HttpHeader] = [],
body: Data? = nil
)
String representation of a URL request.
HTTP request method. Default is GET.
Request header. Empty by default.
Request body. Missing by default.
HttpResponse
Structure for presenting a response for an HTTP request.
The reponse body is stored and handled separately.
public init(
statusCode: HttpStatusCode,
headers: [HttpHeader]
)
HttpStatusCode
HTTP response status code.
public init(
value: Int32 = 0
)
ImageData
Image data: size, format, and binary data.
public init(
size: ScreenSize,
format: ImageFormat,
data: Data
)
IndoorControlOptions
Settings for the floor control element in the building.
public init(visibilityBehavior: VisibilityBehavior)
init(
visibilityBehavior: VisibilityBehavior,
markingByRoute: MarkingByRoute
)
Default settings. Automatic visibility control.
InstructionRouteEntry
Route element - a point and a value in it.
public init(
point: RoutePoint,
value: RouteInstruction
)
IntRouteEntry
Route element - a point and a value in it.
IsOpenNow
Open now.
public init()
LaneOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Left lane.
Middle lane.
Right lane.
LanesCalloutMapPosition
Position of the lane bubble for the route.
public init(
mapId: MapId,
routePoint: RoutePoint,
geoPoint: GeoPoint
)
Identifier of the map for which the position is given.
The lane callout position on the route.
Position of the lane bubble on the map.
LaneSignRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RouteLaneSign
)
Latitude
Geographic latitude.
public init(floatLiteral value: Double)
Creates an instance initialized to the specified floating-point value.
Value to create.
LevelId
LevelInfo
Building floor information.
Locale
Locale identifier in the format [language designer]-[region designer]. Where language designer is the language code described in ISO 639-1, region designer is the country code described in ISO 3166-1.
static func makeLocale(
localeStr: String
) -> Locale?
Creates a locale from a string representation in the LanguageTag or POSIX format.
func toLocalePosix() -> String
LocalizationOptions
Application localization settings. Allows you to set the set of locales used to localize the map and guide.
public init(locales: [Locale], systemLocales: [Locale])
Localization settings constructor.
The systemLocales parameter is a list of the user's preferred languages.
public init(locales: [Locale])
Localization settings constructor.
The systemLocales parameter is a list of the user's preferred languages.
List of locales supported by the application.
List of locales supported by the application. If an empty list is passed, system locales are used.
List of system locales. If an empty list is passed, en-EN is used.
Default settings. Using the list of user's preferred languages.
Location
Geoposition.
public init(
coordinates: LocationCoordinates,
altitude: LocationFuzzyDouble?,
course: LocationCourse?,
groundSpeed: LocationFuzzyDouble?,
source: String,
timestamp: TimeInterval
)
coordinates::value - geoposition coodinates. coordinates::accuracy - horizontal accuracy of geopositioning coordinates (DRMS), m. https://en.wikipedia.org/wiki/Circular_error_probable Value range: >= 0.
altitude::value - altitude above the WGS84 reference ellipsoid, m. altitude::accuracy - standard deviation of the altitude measurement error, m. nil means that the platform does not provide this field. https://en.wikipedia.org/wiki/Standard_deviation Value range: (nil, > 0).
course::value - bearing (direction of travel along the Earth's surface. The angle is measured relative to geographic north). course::accuracy - standard deviation of the error of the bearing measurement. nil means that the platform does not provide this field. https://en.wikipedia.org/wiki/Standard_deviation Value range: (nil, > 0).
ground_speed - speed along the Earth surface, m/s. Value range: >= 0. ground_speed::accuracy - mean square deviation of the speed measurement error, m/s. nil means that the platform does not provide this field. https://en.wikipedia.org/wiki/Rayleigh_distribution Value range: (nil, > 0).
Name of the geoposition source.
The timestamps between different geoposition sources are not synchronized, so you cannot compare the timestamps of geopositions that are derived from different sources.
Time point at which the geoposition was determined. This point is not attached to any specific date and is used solely to calculate the time between two geopositioning measurements obtained from one geopositioning source in one session. This field should increase monotonically (even when the system is in sleep mode).
LocationCoordinates
LocationCourse
LocationFuzzyDouble
LogicalPixel
Pixel the size of which is independent of screen density.
public init(
value: Float = 0
)
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Value to create.
LogMessage
Message being logged.
LogOptions
SDK logging settings.
Minimum level of errors that go into the system log (os_log).
Minimal level of errors in the user's logging receiver.
Custom logging receiver.
Default settings. Warnings and more critical events are logged.
Longitude
Geographic longitude.
public init(floatLiteral value: Double)
Creates an instance initialized to the specified floating-point value.
Value to create.
MapDirection
Angle of the object relative to the north direction, in degrees, counted clockwise.
MapGestureViewFactory
Default gesture processing factory.
public func makeGestureView(
map: Map,
eventProcessor: IMapEventProcessor,
coordinateSpace: IMapCoordinateSpace
) -> UIView & IMapGestureView
Creates a gesture handling layer.
MapGestureViewOptions
Default gesture layer settings.
public init(
doubleTapScalingCenter: ScalingCenter,
twoFingerTapScalingCenter: ScalingCenter,
pinchScalingCenter: ScalingCenter
)
Default settings. For double tap and two-finger tap gestures, zooming is relative to the location of the gesture.
MapId
Identifier of the map instance, unique within the process.
public init(
value: Int32 = 0
)
MapOptions
Initial map properties that can be set during its initialization. A property set to nil will not be applied, so the default value will be used.
Number of physical screen points in a line 2.54 cm long.
Multiplier that is calculated as the ratio of devicePPI to the device's base DPI. The multiplier value corresponds to the nativeScale of the target screen.
Camera location relative to the map.
Relative location of the map location point in the camera view space.
Boundaries of the map zoom.
Map data sources.
Simplified way to specify map data sources.
Initial map style with delayed loading. The style can be loaded using an IStyleFactory instance, see. Container.styleFactory'. Use Future.makeReadyValue(style)` if the style is already loaded.
Gesture processing layer factory. If nil, gestures are not processed until the IMapView.gestureView property is set.
Selection of a theme within the selected map style, taking into account the environment.
Maximum allowable map refresh frequency.
Maximum allowable map refresh frequency in energy saving mode.
Backgroud color for loading styles.
Initial settings set when creating map objects. The DPI is determined based on the main device screen (see DevicePpi.autodetected). If autodetected fails, DevicePpi.defaultForFailedAutodetection is used.
MarkedUpText
Span text.
public init(
text: String,
matchedParts: [MarkedUpTextSpan]
)
Text.
Set of non-overlapping Span, in order, in a text string describing parts that match the user's query.
MarkedUpTextSpan
Describes a subset of bytes of the string text.
MarkerOptions
Marker settings.
public init(
position: GeoPointWithElevation,
icon: Image?,
iconMapDirection: MapDirection? = nil,
anchor: Anchor = Anchor(x: 0.5, y: 0.5),
text: String? = nil,
textStyle: TextStyle? = nil,
iconOpacity: Opacity = Opacity(value: 1),
visible: Bool = true,
draggable: Bool = false,
iconWidth: LogicalPixel = LogicalPixel(value: 0),
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
animatedAppearance: Bool = true,
levelId: LevelId? = nil,
iconAnimationMode: AnimationMode = AnimationMode.normal
)
Target width used for scaling.
Object drawing level.
Whether to animate the appearance.
Binding to the floor plan of the building.
Animation mode.
MeasurementFormatterOutput
Result of the formatting of the measurement.
Meter
Length/distance in meters.
public init(
value: Float = 0
)
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Value to create.
MillisecondsRouteEntry
Route element - a point and a value in it.
MTLDeviceError
NavigationViewOptions
Navigator interface settings.
public init(
mapControlsBehaviour: NavigationViewMapControlsBehaviour = .visibleWhenNavigationActive,
distanceFormattingStrategy: DistanceFormattingStrategy = .default,
durationFormattingStrategy: DurationFormattingStrategy = .default,
durationValueFormattingStrategy: DurationValueFormattingStrategy = .default,
timeFormattingStrategy: TimeFormattingStrategy = .default,
speedFormattingStrategy: SpeedFormattingStrategy = .default,
theme: NavigationViewTheme = .default,
roadEventCardViewOptions: RoadEventCardViewOptions = .default,
roadEventCreationEnabled: Bool = true
)
Settings constructor.
Behavior of the camera controllers in navigation mode.
Way of formatting distances.
Way to format the time interval.
Formats the time interval value.
Formats date/time.
Formats speed.
Navigator theme.
Traffic event card settings.
Whether a traffic event creation controller is needed.
Navigator default interface settings.
NavigationViewTheme
Navigator theme.
public init(colors: Colors)
public init(
colors: Colors,
dashboardTheme: DashboardTheme,
remainingRouteInfoControlTheme: RemainingRouteInfoControlTheme,
nextManeuverControlTheme: NextManeuverControlTheme,
speedControlTheme: SpeedControlTheme,
cameraControlTheme: CameraControlTheme,
messageBarControlTheme: MessageBarControlTheme,
mapControlsTheme: MapControlsTheme,
betterRouteControlTheme: BetterRouteControlTheme,
thermometerTheme: ThermometerTheme
)
Default navigator theme.
NoopCancellable
Ready-made ICancellable implementation that does not override anything.
public init()
public func cancel()
ObstacleInfo
Obstacle information on the route.
public init(
type: Obstacle = Obstacle.other,
limitation: ObstaclePassLimitation = ObstaclePassLimitation.unlimited
)
ObstacleInfoRouteEntry
Route element - a point and a value in it.
ObstacleInfoRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: ObstacleInfo
)
Opacity
Opacity - from 0.0 (full transparency) to 1.0 (full opacity).
public init(
value: Float = 0
)
OpeningHours
Hours of operation for the organization.
public init(
weekOpeningHours: [[WeekTimeInterval]],
isOpen24x7: Bool
)
Hours of operation for each day of the week, starting on Monday.
OrderedValue
Describes one value from the set.
OrderedValues
Describes a set of sorted values.
public init(
values: [OrderedValue],
currentMinIndex: UInt64? = nil,
currentMaxIndex: UInt64? = nil
)
Set of values. Sorted in the ascending order.
Index of the currently set minimum value.
Index of the currently set maximum value.
PackageInfo
Package information. See IPackage.
public init(
name: String,
installed: Bool = false,
incomplete: Bool = true,
preinstalled: Bool = false,
compatible: Bool = false,
hasUpdate: Bool = false,
error: PackageInfoError?,
updateStatus: PackageUpdateStatus = PackageUpdateStatus.notAvailable
)
Localized name of the package.
Installation sign - true if the package has been selected for installation.
Sign of incomplete installation - true if there is no fully downloaded version of the package (possibly incompatible with the current SDK version).
Sign of preinstalled packages. Preinstalled packages are always installed and fully loaded, and cannot be removed.
Compatibility sign - true in case the downloaded package is compatible with the current SDK version.
Update availability sign is true in case there is an update for the downloaded package. It is possible situation, when during update process to new version even newer version of the package became available on the server. In this case the value will be true both during and after the upgrade.
Error that occurs during an attempt to download and/or install a package. If no error occurs, nil is returned.
Package upgrade status.
Padding
Padding the edges of the camera.
ParkingCapacity
Parking capacity.
public init(
total: String?,
specialSpaces: [SpecialSpace]
)
Total parking capacity, parking spaces.
Description of special parking spaces.
ParkingInfo
General information about the parking lot.
public init(
type: ParkingType?,
purpose: ParkingPurpose,
access: ParkingAccess,
pavingType: ParkingPavingType?,
isPaid: Bool,
isIncentive: Bool,
forTrucks: Bool,
levelCount: UInt16?,
capacity: ParkingCapacity?
)
Type.
Value.
Access type.
Coverage type.
Whether the parking lot is a paid parking lot.
Whether the parking lot is intercepting.
Are there spaces for trucks.
Number of levels.
Capacity.
PedestrianBriefRouteInfo
Basic information about the walking route.
PedestrianInstructionCrossroad
Description of maneuvers when passing through an intersection or crosswalk.
public init(
landmark: PedestrianInstructionCrossroadLandmark = PedestrianInstructionCrossroadLandmark.`none`,
maneuvers: [PedestrianInstructionCrossroadManeuver]
)
Chain of sequential maneuvers.
PedestrianInstructionCrossroadManeuver
public init(
direction: PedestrianInstructionCrossroadManeuverDirection = PedestrianInstructionCrossroadManeuverDirection.straight,
turnAngle: Int32 = 0
)
Direction of travel.
Turning angle in degrees [-180, 180].
PedestrianInstructionFinish
End of the pedestrian part of the route.
public init()
PedestrianInstructionIndoorEnter
Entrance to the building.
Floor ID after entering the building.
PedestrianInstructionIndoorExit
Building exit.
public init()
PedestrianInstructionIndoorFloorChange
Floor change in the building.
public init(
type: PedestrianInstructionIndoorFloorChangeType = PedestrianInstructionIndoorFloorChangeType.undefined,
beginId: LevelId = LevelId(),
endId: LevelId = LevelId()
)
Floor change type.
Floor ID before shift.
Floor ID after shift.
PedestrianInstructionStart
Starts of the walking part of the route.
public init()
PedestrianRouteSearchOptions
Pedestrian route search options.
public init(
avoidStairways: Bool = false,
avoidUnderpassesAndOverpasses: Bool = false,
useIndoor: Bool = true,
excludedAreas: [ExcludedArea] = []
)
Avoid stairs.
Avoid underpasses and overpasses.
Build routes inside buildings.
Excluded areas (not more than 25).
PersonalDataCollectionOptions
Personal data collection and processing settings.
public init(personalDataCollectionConsent: PersonalDataCollectionConsent)
User choice regarding the collection and processing of personal data.
Default settings. Permission to collect and process personal data has been granted.
PlatformPositioningServicesFactory
Implementation of CLLocationManager-based geopositioning services.
public init(
locationManager: CLLocationManager = CLLocationManager()
)
Geopositioning source interface. If nil, SDK geopositioning functions are not available.
Magnetic orientation source interface. If nil, the SDK magnetic orientation functions are not available.
PolygonOptions
Polygon parameters.
public init(
contours: [[GeoPoint]],
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value: 0),
strokeColor: Color = Color(),
visible: Bool = true,
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
levelId: LevelId? = nil
)
Object drawing level.
Binding to the floor plan of the building.
PolylineOptions
Polyline parameters.
public init(
points: [GeoPoint],
width: LogicalPixel = LogicalPixel(value: 1),
color: Color = Color(),
erasedPart: Double = 0,
dashedPolylineOptions: DashedPolylineOptions? = nil,
gradientPolylineOptions: GradientPolylineOptions? = nil,
visible: Bool = true,
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
levelId: LevelId? = nil
)
Polyline points.
Polyline width.
Main color of the polyline.
Proportion of erased part of the polyline, must be in the [0; 1] range.
Dashed polyline options.
Dashed gradient line is not currently supported, so if both dashed_polyline_options and gradient_polyline_options are present in PolylineOptions, the dashed_polyline_options will be ignored when creating a polyline.
Gradient polyline options.
Dashed gradient line is not currently supported, so if both dashed_polyline_options and gradient_polyline_options are present in PolylineOptions, the dashed_polyline_options will be ignored when creating a polyline.
Visibility of a polyline.
User data.
Object drawing level.
Binding to the floor plan of the building.
PublicBriefRouteInfo
Basic information about the route on public transportation.
public init(
publicTransportInfos: [PublicBriefRouteTransportInfo]
)
Description of route options on public transportation.
PublicBriefRouteTransportInfo
Description of the means of public transportation.
public init(
type: PublicTransportType = PublicTransportType.bus,
names: [String],
color: UInt32?,
routeLogo: String
)
Type of public transport vehicle.
Names of the used public transport routes.
ARGB representation of the color associated with a given public transport mode, such as the color of a subway line. If there is no information about the color, the field will be nil.
Icon identifier for route stops. An empty string if no information is available. Technical field.
PublicRoutePart
Description of the section of the route on public transportation.
public init(
transports: [PublicTransportInfo],
intermediateStops: [PublicTransportStop]
)
Types of public transport that can be used to travel this section of the route.
If the list is empty, this route section is suggested to be traveled by private or rented transport or on foot.
Intermediate stops that transport will pass before reaching the transfer point.
PublicTransportInfo
Description of the means of public transportation.
Type of public transport vehicle.
Names of the used public transport routes.
Car numbers in that boarding recommended.
If a vehicle consists of a single car or one can board any car, this list will be empty.
Text description of the cars in which boarding is recommended.
ARGB representation of the color associated with a given public transport mode, such as the color of a subway line. If there is no information about the color, the field will be nil.
Icon identifier for route stops. An empty string if no information is available. Technical field.
PublicTransportRouteSearchOptions
Route search options on public transport.
public init(
startTime: Date? = nil,
useSchedule: Bool = false,
transportTypes: PublicTransportTypeOptionSet = []
)
Time in UTC for which the route is to be plotted. If not specified, the current time is used.
Public transport schedules are taken into account when constructing the route.
Types of public transport. If not filled in, routes will be built for all supported public transport types.
PublicTransportStop
Description of the public transport stop.
PublicTransportTransfer
Description of the way to get by public transport to the next transfer point.
public init(
startPointName: String,
finishPointName: String,
routeParts: [PublicRoutePart]
)
Name of the point from which the movement starts for this section of the route.
Name of the destination point for this section of the route.
Description of the route section on public transport to get to the next transfer point.
PublicTransportTransferRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: PublicTransportTransfer
)
PublicTransportTypeOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Trolleybus.
Shuttle bus.
Subway.
Suburban train.
Funicular.
Monorail.
Water transport.
Cable car.
High-speed tram.
Underground tram.
Light metro.
Aeroexpress.
Moscow Central Ring.
Moscow Central Diameters.
PurposeCode
Code of the purpose of the building.
RangeFilter
Filter of value ranges.
RenderedObject
Displayed map object.
RenderedObjectInfo
Detailed information about the displayed map object.
public init(
closestViewportPoint: ScreenPoint,
closestMapPoint: GeoPointWithElevation,
item: RenderedObject
)
Nearest object point in the screen coordinates.
Nearest point of the object in map coordinates.
Displayed object on the map.
Reviews
Reviews.
RoadCameraInfo
Camera information.
public init(
purposes: CameraPurposeOptionSet,
speedLimit: UInt16?
)
Camera purpose.
May be missing if there is no information, or if the camera was added by a user.
Speed limit in km/h.
RoadEventActionInfo
Action information.
public init(
state: RoadEventActionState,
count: UInt32?
)
Action state.
Number of actions applied to the event by all users (for custom events only).
RoadEventCardViewOptions
Traffic event card settings.
public init(
timeFormattingStrategy: TimeFormattingStrategy = .default
)
Settings constructor.
Method of formatting date/time.
Default traffic event card settings.
RoadEventDisplayCategoryOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Cameras of all types, including those added by the user.
Comments on the roads.
Traffic accident.
Road closures.
Road works.
Events in the Other category.
Always displays events created by the current user, regardless of their category.
RoadEventRouteEntry
Route element - a point and a value in it.
RoadRuleRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadRule
)
RoadSubtypeRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadSubtype
)
RoadSurfaceRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadSurface
)
RoadTypeRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RoadType
)
RouteBuildOptions
The structure that describes the route building parameters in the navigator.
public init(
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions
)
The point to which the route is built.
Route search parameters.
RouteCamera
Structure describing the traffic camera.
public init(
purposes: RouteCameraPurposeOptionSet,
rangeAgainst: RouteDistance,
rangeAlong: RouteDistance,
direction: RouteCameraDirection = RouteCameraDirection.against
)
Camera purposes.
Range of camera action against the motion.
Range of the camera against the motion.
Direction of camera action.
RouteCameraPurposeOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Recording of exceeding the speed limit.
Recording of passing at the forbidden signal of traffic lights.
Recording of driving over the stop line, driving without stopping the stop sign, driving to the intersection during a jam.
Recording of movement on the dedicated lane for public transport.
Recording driving in the oncoming lane.
Recording of failure to give preference to pedestrians.
Recording of violation of lane rotation at the intersection.
Recording of crossing the solid line of road markings, driving on the side of the road.
Recording of exceeding the average speed on the section.
Recording of violation of prohibition of stopping.
Fake item.
Platon” system camera: https://platon.ru/en/about/.
RouteDistance
Distance along the route.
public init(
millimeters: Int64 = 0
)
RouteEditorRouteParams
Route parameter information.
public init(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: [RouteSearchPoint] = []
)
RouteEditorRoutesInfo
Information about the routes the editor operates on.
public init(
routes: [TrafficRoute],
routeParams: RouteEditorRouteParams
)
When the route list is updated, the first route will be active if the route list is not empty.
Route parameters for which the search was performed. Can be different from the parameters passed to the editor, if routes were found already after the parameters were changed in the editor.
RouteExitSign
Exit sign information.
public init(
type: RouteExitSignType = RouteExitSignType.undefined,
roadNameTable: RouteExitSignTable,
roadNumberTable: RouteExitSignTable?
)
Exit type.
Exit sign with the road name.
Exit sign with the road number.
RouteExitSignRouteEntry
Route element - a point and a value in it.
RouteExitSignTable
Exit sign information.
public init(
backgroundColor: RouteExitSignTableColor = RouteExitSignTableColor.undefined,
text: String
)
Background color of an exit sign.
Exit sign text.
RouteIndex
RouteInfo
Route description with maneuvers.
public init(
route: Route,
routeBuildOptions: RouteBuildOptions?
)
Route.
Route construction parameters in the navigator. The nil value means that the route has no finish point. In this case, a section of road, which is supposedly used by the user, is calculated based on the road graph and parameters of the user's movement and is returned as a route in the route field. Consequently, this route cannot contain instructions, and the last point in this route is not the destination point to which the user is moving, but simply the point to which the user's movement was predicted. It is not known where the user will go next. This mode of the navigator operation is called a mode of guidance without a route or free roam.
RouteInstruction
The instruction that must be executed to drive the route.
public init(
roadName: String,
range: RouteDistance,
extraInstructionInfo: ExtraInstructionInfo
)
Name of the road on which the user will end up after performing the maneuver.
Distance after the instruction point, during which the user is considered to be in the instruction coverage area.
Specific information for a particular type of instruction.
RouteLane
Structure describing a single lane.
public init(
routeManeuver: RouteLaneManeuver = RouteLaneManeuver.undefined,
maneuvers: RouteLaneManeuverOptionSet,
speedLimit: Float = 0,
prohibited: Bool = false,
onlyPublicTransport: Bool = false
)
Maneuver to be performed to move along the route.
Allowed maneuvers to be made in the lane.
Maximum permitted speed on the lane is m/s. 0 - speed limit is unknown.
No passing in the lane.
Public transportation lane.
RouteLaneManeuverOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Not set.
Straight ahead.
To the right.
To the left.
Slightly to the right.
Slightly to the left.
Sharply to the right.
Sharply to the left.
To the right, then to the left.
U-turn.
RouteLaneSign
Description of the lanes.
public init(
lanes: [RouteLane],
signStartPoint: RoutePoint?,
signPoint: RoutePoint?,
signEndPoint: RoutePoint?
)
Lanes for cars on a road section. Listed in order from the edge to the middle of the roadway.
If the number of lanes is unknown or there is only one lane on the road in the direction of the route, this array is empty.
Point on the route at which the lane traffic sign starts. nil if the starting position of the sign is unknown.
Point on the route at which the lane control sign begins. nil if the position of the sign is unknown.
Point on the route at which the lane control sign ends. nil if the end position of the sign is unknown.
RouteLevelInfo
Building floor information corresponding to the route section.
Floor plan ID at the starting point of the route section. Not present if the point is not in a building.
Floor plan ID at the end point of the route section. Not present if the point is not in a building.
Floor name. Empty if the route section connects different floors.
RouteLevelInfoRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: RouteLevelInfo
)
RouteMapObjectCalloutLabelFlagOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Time of travel along the route.
Route length.
RouteMapObjectDisplayFlagOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Route segments.
Starting point of the route.
Finish point of the route.
Intermediate waypoints.
Connection points of route segments (except for routes on public transport). For example, a point at the junction point of a pedestrian and automobile segment.
Maneuvers.
Artificial bumps.
Road closures.
Gates, barriers.
Public transport stops.
Traffic accident.
Road works.
Comments.
Traffic closures.
Other" events.
Start and end of toll road.
Lane bubbles (displayed only in source with navigation mode).
Lane bubbles with travel time and route length.
Instructions in buildings. Move by elevator, escalator, etc.
Shows parts of the route inside buildings not just for the active floor.
Highlight traffic lights on the route.
RouteMapObjectPermanentDisplayFlagOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
The corresponding value of the raw type.
Starting point of the route.
Finish point of the route.
Intermediate waypoints.
Traffic accident.
Road works.
Traffic closures.
Other" events.
Start and finish of toll road.
RoutePoint
Point on the route, set as the distance along the route relative to the start of the route.
RouteSearchPoint
Description of the points on which the route is built.
public init(
coordinates: GeoPoint,
course: Bearing? = nil,
objectId: DgisObjectId = DgisObjectId(objectId: 0, entranceId: 0),
levelId: LevelId? = nil
)
Coordinates through which to route.
Direction in which to traverse the point.
ID of the object to which the walking part of the route will be traversed.
Identifier of the floor plan (for pedestrian routes).
RubricId
Schedule
Road event action schedule.
public init(
startTime: Date?,
finishTime: Date?,
weekTimeIntervals: [WeekTimeInterval]
)
Start time of action. None if unknown.
Start time of action. None if unknown.
Intervals of operation within the week.
ScooterBriefRouteInfo
Basic route information on the scooter.
ScooterInstructionCrossroad
Description of maneuvers when passing through an intersection or crosswalk.
public init(
landmark: ScooterInstructionCrossroadLandmark = ScooterInstructionCrossroadLandmark.`none`,
maneuvers: [ScooterInstructionCrossroadManeuver]
)
Landmark.
Chain of sequential maneuvers.
ScooterInstructionCrossroadManeuver
public init(
direction: ScooterInstructionCrossroadManeuverDirection = ScooterInstructionCrossroadManeuverDirection.straight,
turnAngle: Int32 = 0
)
Direction of travel.
Turning angle in degrees [-180, 180].
ScooterInstructionFinish
End of the scooter part of the route.
public init()
ScooterInstructionStart
Start of the scooter part of the route.
public init()
ScooterRouteSearchOptions
Search parameters for scooter routes.
public init(
avoidCarRoads: Bool = true,
avoidStairways: Bool = true,
avoidUnderpassesAndOverpasses: Bool = true,
excludedAreas: [ExcludedArea] = []
)
Avoid roads.
Avoid stairs.
Avoid underpasses and overpasses.
Excluded areas (not more than 25).
ScreenDistance
Distance between objects on the screen in millimeters.
Cannot be negative.
public init(
value: Float = 0
)
ScreenPoint
Point in screen coordinates.
public init(
x: Float = 0,
y: Float = 0
)
ScreenShift
Horizontal and vertical displacement of the map in the coordinates space of the screen.
public init(
dx: Float = 0,
dy: Float = 0
)
ScreenSize
Size in pixels.
SDKError
SegmentGeoPoint
Describes a geographic point on the segment and the direction of the segment. The route geometry is a sequence of points that form segments in pairs. For all functions working with the route geometry, it is considered that the first point of the pair forming the segment is included in this segment, and the second one is not: [point_1, point_2),[point_2, point_3),...,[point_n-1, point_n)[point_last]. The last point forms a zero-length segment with itself. Thus, each point of the route belongs to exactly one segment. The direction of point_last is not defined.
SettlementRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: Settlement
)
SimpleClusterOptions
Parameters of the cluster marker simple marker objects.
public init(
icon: Image?,
iconMapDirection: MapDirection? = nil,
anchor: Anchor = Anchor(x: 0.5, y: 0.5),
text: String? = nil,
textStyle: TextStyle? = nil,
iconOpacity: Opacity = Opacity(value: 1),
iconWidth: LogicalPixel = LogicalPixel(value: 0),
userData: Any = (),
zIndex: ZIndex = ZIndex(value: 0),
animatedAppearance: Bool = true,
iconAnimationMode: AnimationMode = AnimationMode.normal
)
Target width used for scaling.
Object drawing level.
Whether to animate the appearance.
Animation mode.
SimpleError
public static func == (lhs: SimpleError, rhs: SimpleError) -> Bool
Returns a Boolean value indicating whether two values are equal.
SimulationAutoWithOverSpeed
Structure for setting the mode of driving taking into account the maximum speed on the route edge.
Used exceeding of the speed limit in m/s. Only values >= 0 are acceptable.
SimulationConstantSpeed
Structure for setting the mode of driving with constant speed.
Travel speed in m/s. Only values >= 0 are acceptable.
SortingFilter
Sorting type.
SoundCategoryOptionSet
public init(rawValue: UInt32)
Creates a new option set from the given raw value.
Raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.
Corresponding value of the raw type.
Intersection control cameras.
Cameras recording traffic in the dedicated lane for public transport.
Stop control cameras.
Traffic lane cameras.
Average speed cameras.
Instant speed cameras.
Accidents.
Road works.
Toll roads.
Violations of maximum permitted speed.
Intermediate points on the route.
Route is rebuilt.
Instructions (maneuvers) on route.
Obstacles.
Road subtypes.
Lost GPS signal.
Route completion.
SpecialSpace
Special parking space.
public init(
type: SpecialSpaceType,
name: String,
count: String?
)
Type.
Localized name of a special place.
Number of spaces of this type in the parking lot.
SpeedRange
Speed interval. Speeds are specified in meters per second.
SpeedRangeToStyleZoom
Matching speed interval and style zoom.
public init(
range: SpeedRange,
minDistanceToManeuver: RouteDistance,
maxDistanceToManeuver: RouteDistance,
styleZoom: StyleZoom
)
Speed interval.
Minimum distance to the maneuver at which the smooth zoom level logic should be activated.
Maximum distance after the maneuver at which the smooth zoom level reduction should end.
Style zoom.
StringRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: String
)
StyleLayerId
StyleZoom
Style zoom level.
Cannot be negative.
public init(
value: Float = 0
)
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Value to create.
TaxiRouteSearchOptions
Parameters for route search by taxi.
Route search parameters common to other car routes.
TextStyle
Text appearance settings.
public init(
fontSize: LogicalPixel = LogicalPixel(value: 8),
color: Color = Color(),
strokeWidth: LogicalPixel = LogicalPixel(value: 0.3499999940395355),
strokeColor: Color = Color(argb: 4294967295),
textPlacement: TextPlacement = TextPlacement.bottomCenter,
textOffset: LogicalPixel = LogicalPixel(value: 0),
fontName: String? = nil
)
Theme
Specifies a theme within some style (see Style).
public init(stringLiteral value: String)
Creates an instance initialized to the given string value.
Value of the new instance.
Textual representation of this instance.
Tilt
Tilt angle in degrees, where 0 is nadir (looking vertically down), 90 is front horizon.
public init(
value: Float = 0
)
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Value to create.
TradeLicense
License of the organization.
TrafficControlState
State of the traffic control.
public init(
status: TrafficControlStatus = TrafficControlStatus.hidden,
score: UInt32?
)
Status, depending on which changes the appearance of the control.
Traffic score. Displayed as an inscription on the control. If absent, a blank icon is displayed.
TrafficScore
Traffic rate.
public init(
state: TrafficScoreState = TrafficScoreState.pending,
value: UInt32?
)
Value relevance.
Value in points. Typically values are in the range of 1 to 10. Blank value if the information is not yet received, or is already out of date, or is not available for the given location.
TrafficSpeedColorRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: TrafficSpeedColor
)
TransportTypeRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: TransportType
)
TruckPassZoneId
Identifier of the pass zone for trucks. The value 0 corresponds to the absence of the pass zone.
TruckPassZoneIdRouteLongEntry
Extended route element - segment and value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: TruckPassZoneId
)
TruckPassZonePass
Pass allowing truck traffic in the pass zones.
public init(
id: TruckPassZonePassId,
name: String,
passZoneIds: Set<TruckPassZoneId>
)
Skip ID.
Skip name.
IDs of the pass zones that can be accessed with this pass.
TruckPassZonePassId
TruckRouteSearchOptions
Truck route search parameters. Only filled parameters are taken into account when searching a route.
public init(
car: CarRouteSearchOptions,
truckLength: UInt32? = nil,
truckHeight: UInt32? = nil,
truckWidth: UInt32? = nil,
actualMass: UInt32? = nil,
maxPermittedMass: UInt32? = nil,
axleLoad: UInt32? = nil,
dangerousCargo: Bool = false,
explosiveCargo: Bool = false,
passIds: Set<TruckPassZonePassId> = [],
fallbackOnCar: Bool = false
)
Route search parameters common to other car routes.
Length of cargo vehicle in millimeters.
Cargo vehicle height in millimeters.
Cargo vehicle width in millimeters.
Actual weight of cargo vehicle in kilograms.
Permissible maximum weight of cargo vehicle in kilograms.
Axle load in kilograms.
Dangerous cargo indication.
Indication of the presence of explosives in cargo.
Identifiers of the user's existing passes required to move within the pass zones.
Use of automatic fallback from cargo route search to vehicle route search when unable to find a cargo route that satisfies the search parameters.
UIMarkerInfo
ID of an object with caption.
UIntRouteLongEntry
Extended route element - a segment and a value on it.
public init(
point: RoutePoint,
length: RouteDistance,
value: UInt32
)
UnavailablePositioningServicesFactory
Implementation of geopositioning services that disables access to these functions.
public init()
Geopositioning source interface. If nil, SDK geopositioning functions are not available.
Magnetic orientation source interface. If nil, the SDK magnetic orientation functions are not available.
VendorConfigOptions
2GIS SDK settings for working in standalone configurations.
File with settings overrides.
WeekTime
Timestamp within a week.
public static func < (lhs: WeekTime, rhs: WeekTime) -> Bool
Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.
WeekTimeInterval
Time interval during the week.
WorkStatus
Operating status.
ZIndex
Index that sets the order in which objects are rendered within a layer.
Zoom
Zoom level.
Cannot be negative.
public init(
value: Float = 0
)
public init(floatLiteral value: Float)
Creates an instance initialized to the specified floating-point value.
Value to create.