Skip to main content

class

ActivityTracker​

Extends: ru.dgis.sdk.NativeObject
ActivityTracker(
	platformContext: Context,
	model: Model,
	speedBound: Double = 4.2,
	timeThreshold: Duration = Duration.ofMilliseconds(20000)
)

Navigator extension that monitors user activity and emits a signal when the user has stopped using the navigator and can be turned off.

Parameters

platformContext

Context.

model

Model of the navigator which status is being monitored.

speedBound

Upper speed limit in m/s, above which in the Finished state of the navigator it is considered that the navigator is active, i.e. the movement continues.

timeThreshold

The amount of time the navigator's Finished state monitors movement below the threshold to determine if the navigator is inactive. If during this time the movement rate is below the set threshold, or there is no location and speed data, the Navigator is considered inactive.

Properties

val stopChannel​

Active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, (the movement stops or its speed falls below the threshold) and this state persists for some time, the flag is set to true, otherwise it is set to false.

val stop​

Active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, (the movement stops or its speed falls below the threshold) and this state persists for some time, the flag is set to true, otherwise it is set to false.

AddEventResult​

Result of adding an event (event object or error).

AddEventResult(event: RoadEvent)
Parameters

event

AddEventResult(error: AddEventError)
Parameters

error

Methods
fun match(event: Function1, error: Function1): T
Parameters

event

error

Returns
T
fun toString(): String
Returns
String
fun hashCode(): Int
Returns
Int
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
Properties

val isEvent​

val asEvent​

val isError​

val asError​

val value​

Address​

Address as a set of separate components.

Address(
	drillDown: List<AddressAdmDiv>,
	components: List<AddressComponent>,
	buildingName: String?,
	postCode: String?,
	buildingCode: String?,
	fiasCode: String?,
	addressComment: String?
)

Address as a set of separate components.

Parameters

drillDown

components

buildingName

postCode

buildingCode

fiasCode

addressComment

Properties

val drillDown​

Set of administrative division objects where the described object is located.

val components​

Full address of an object may contain several separate address components.

val buildingName​

Name of the building.

val postCode​

ZIP code.

val buildingCode​

Unique ZIP code of the building.

val fiasCode​

FIAS code of the building.

val addressComment​

Comment on the address. Example: "office 301; 9th floor"

AddressAdmDiv​

Object of administrative division.

AddressAdmDiv(type: String, name: String)

Object of administrative division.

Parameters

type

name

Properties

val type​

The type of the administrative unit. One of the following:

  • country
  • region (province/territory/republic, etc.)
  • district_area - district of the region
  • city
  • settlement
  • division
  • district
  • living_area - residential estate, microdistrict
  • place

val name​

AddressComponent​

Address component: street, house number, or verbal description of location.

AddressComponent(streetAddress: AddressStreet)
Parameters

streetAddress

AddressComponent(number: AddressNumber)
Parameters

number

AddressComponent(location: AddressLocation)
Parameters

location

Methods
fun match(
	streetAddress: Function1,
	number: Function1,
	location: Function1
): T
Parameters

streetAddress

number

location

Returns
T
fun toString(): String
Returns
String
fun hashCode(): Int
Returns
Int
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
Properties

val isStreetAddress​

val asStreetAddress​

val isNumber​

val asNumber​

val isLocation​

val asLocation​

val value​

AddressLocation​

Used for components that are difficult to describe with a specific address.

AddressLocation(comment: String)

Used for components that are difficult to describe with a specific address.

Parameters

comment

Properties

val comment​

Text description of the building location.

AddressNumber​

House number used as a full address. In some settlements, only the house number is indicated, without the street (for example, Krasnoobsk).

AddressNumber(number: String, fiasCode: String?)

House number used as a full address. In some settlements, only the house number is indicated, without the street (for example, Krasnoobsk).

Parameters

number

fiasCode

Properties

val number​

House number, including fractions and letters. Can be a proper noun if it is a common practice in the location.

val fiasCode​

FIAS street code.

AddressStreet​

Regular address with a street name and a building number.

AddressStreet(
	street: String,
	number: String,
	fiasCode: String?
)

Regular address with a street name and a building number.

Parameters

street

number

fiasCode

Properties

val street​

Street name.

val number​

House number, including fractions, building numbers, and letters.

val fiasCode​

FIAS street code.

AddRoadEventButton​

Button for adding a road event.

Extends: ru.dgis.sdk.road_events.AddRoadEventControl
AddRoadEventButton(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Button for adding a road event.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit

AddRoadEventCard​

Card for adding a road event.

Extends: ru.dgis.sdk.road_events.AddRoadEventControl
AddRoadEventCard(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Card for adding a road event.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
Properties

const MAX_DESCRIPTION_LENGTH​

AddRoadEventCardModel​

Model of the card for adding a road event.

Implements: java.lang.AutoCloseable
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)

Model of the card for adding a road event.

Parameters

roadEventManager

map

Methods
fun onEventTypeClicked(type: RoadEventType): Unit

Action that occurs when the event type selection control is clicked.

Parameters

type

Returns
Unit
fun onLaneClicked(lane: Lane): Unit

Action that occurs when the lane selection control is clicked.

Parameters

lane

Returns
Unit
fun onDescriptionEntered(description: String): Unit

Action that occurs when entering description.

Parameters

description

Returns
Unit
fun onSendClicked(): Unit

Action that occurs when the submit button is clicked.

Returns
Unit
fun close(): Unit
Returns
Unit
Properties

val eventTypeChannel​

Selected event type.

val lanesChannel​

Selected lanes.

val canSelectLanesChannel​

Whether it is possible to set lanes.

val descriptionChannel​

Entered description.

val markerPositionChannel​

Marker position on the screen.

val canSendChannel​

Whether it is possible to send an event.

val resultChannel​

Result of sending the event.

AddRoadEventControl​

Base class for controls for adding road events.

Extends: android.widget.FrameLayout
AddRoadEventControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Base class for controls for adding road events.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
@CallSuper
fun detachFromModel(): Unit
Returns
Unit
fun onAttachedToWindow(): Unit
Returns
Unit
fun onDetachedFromWindow(): Unit
Returns
Unit
Properties

var model​

val closeables​

AddRoadEventControls​

Set of controls for adding road events. Consists of a card with event parameters, a "Submit" button, and a marker indicating the location of adding an event on the map.

Extends: ru.dgis.sdk.map.MapControl
AddRoadEventControls(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Set of controls for adding road events. Consists of a card with event parameters, a "Submit" button, and a marker indicating the location of adding an event on the map.

Parameters

context

attrs

defStyle

Methods
fun show(): Unit
Returns
Unit
fun hide(): Unit
Returns
Unit
fun attachToMap(map: Map): Unit
Parameters

map

Returns
Unit
fun detachFromMap(map: Map): Unit
Parameters

map

Returns
Unit
Properties

val cardHeightChannel​

Height in pixels to which the card is expanded.

AddRoadEventMarker​

Marker for adding a road event.

Extends: ru.dgis.sdk.road_events.AddRoadEventControl
AddRoadEventMarker(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Marker for adding a road event.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: AddRoadEventCardModel): Unit
Parameters

model

Returns
Unit
fun detachFromModel(): Unit
Returns
Unit

Aggregate​

EV charging station description.

Aggregate(
	connectorsFree: Short,
	connectorsTotal: Short,
	isActive: Boolean,
	isBusy: Boolean,
	power: Short
)

EV charging station description.

Parameters

connectorsFree

connectorsTotal

isActive

isBusy

power

Properties

val connectorsFree​

Number of available connectors (in the Available status).

val connectorsTotal​

Total number of connectors, except for connectors in the Unavailable status.

val isActive​

Shows whether connectors are active. true if there is at least one available (in the Available status), reserved (Reserved), or busy (Charging) connector.

val isBusy​

Shows whether connectors are busy. true if half or more of the connectors are busy (in the Charging status).

val power​

The maximum power of the connector at the station.

AlternativeRouteSelector​

Selects an alternative route.

Extends: ru.dgis.sdk.NativeObject
Methods
fun selectAlternativeRoute(trafficRoute: TrafficRoute): Unit

Selects an alternative route. If the passed route does not match one of the current alternative routes, nothing happens. Otherwise, the appropriate alternative route becomes the current active route.

Parameters

trafficRoute

Alternative route which should be selected as a current active route.

Returns
Unit

AlternativeRoutesProviderSettings​

Settings of searching for alternative routes and a better route.

Extends: ru.dgis.sdk.NativeObject
Properties

var alternativeRoutesEnabled​

Flag to enable/disable suggesting alternative routes. By default, this option is enabled.

var betterRouteEnabled​

Flag to enable/disable suggesting a better route. By default, this option 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 not less than 5 seconds. The default value is 20 seconds.

var betterRouteTimeCostThreshold​

Minimum travel time difference between the original route and the alternative route for which the alternative route is considered a better route.

var betterRouteLengthThreshold​

Minimum total length of route edges that differ between the original route and the alternative route at which the alternative route is considered a better route.

var routerType​

Type of a search engine for finding alternative routes.

Anchor​

Image anchor point. (0, 0) - upper-left corner, (1, 1) - lower-right corner.

Anchor(x: Float = 0.5f, y: Float = 0.5f)

Image anchor point. (0, 0) - upper-left corner, (1, 1) - lower-right corner.

Parameters

x

y

Properties

val x​

val y​

AndroidAutoMapSession​

Car App session that renders a map on the surface provided by the AppManager.

Supports both shift and scale gestures.

The map's visibility is tied to the session's Lifecycle:

  • Map becomes visible during the onStart event.
  • Map becomes hidden during the onStop event.

Action.PAN must be included in the Template. Otherwise, the surface won't be available.

Next permissions are already declared in the SDK:

  • androidx.car.app.ACCESS_SURFACE
  • androidx.car.app.NAVIGATION_TEMPLATES

AndroidAutoMapSession(mapOptions: MapOptions)

Car App session that renders a map on the surface provided by the AppManager.

Supports both shift and scale gestures.

The map's visibility is tied to the session's Lifecycle:

  • Map becomes visible during the onStart event.
  • Map becomes hidden during the onStop event.

Action.PAN must be included in the Template. Otherwise, the surface won't be available.

Next permissions are already declared in the SDK:

  • androidx.car.app.ACCESS_SURFACE
  • androidx.car.app.NAVIGATION_TEMPLATES

Parameters

mapOptions

The configuration of the map. The following parameters are not utilized:

Methods
fun onSurfaceAvailable(
	surface: Surface,
	width: Int,
	height: Int
): Unit

Provides a surface for rendering additional content on top of the map. This surface can be created and provided before the onMapReady callback is triggered.

Parameters

surface

The Surface object that will be used for rendering content on top of the map.

width

The width of the surface.

height

The height of the surface.

Returns
Unit
fun onSurfaceDestroyed(surface: Surface): Unit

Indicates that the surface has been destroyed.

Parameters

surface

Returns
Unit
fun onSurfaceClicked(x: Float, y: Float): Unit

Forwards the SurfaceCallback.onClick event.

Parameters

x

y

Returns
Unit
fun onMapReady(map: Map): Unit

Provides a map when it is successfully initialized.

Parameters

map

Returns
Unit
fun onMapReadyException(exception: Exception): Unit

Provides an exception in case of an error during initialization.

Parameters

exception

Returns
Unit
fun setTheme(theme: MapTheme): Unit

Applies the theme to the map.

This takes effect only after the map has been initialized (i.e., after onMapReady has been called). To set a theme before the map is initialized, use the mapOptions#mapTheme.

Parameters

theme

Theme to be applied. The loadingBackground attribute is not utilized.

Returns
Unit
fun setCopyrightPosition(position: CopyrightPosition): Unit

Sets the position of the copyright icon on the screen.

Important: This method must be called only after the onCreate state of Lifecycle.

Parameters

position

The position of the copyright icon.

Returns
Unit

AnimationSettings​

Settings of map object animations. Applied to style layers with a model source specified. For example, layers of the "3D model" and "Directional model" type.

Extends: ru.dgis.sdk.NativeObject
Properties

var animationIndex​

Gets the index of the current model animation. If null, the value from styles is used.

var sceneIndex​

Gets the index of the current model scene. If null, the value from styles is used.

var sceneName​

Gets the title of the current model scene. If null, the value from styles is used.

var animationRepeatCount​

Gets the number of the model animation repetitions. If null, the value from styles is used.

var animationSpeed​

Gets the speed of playing the model animation. If null, the value from styles is used.

ApartmentRange​

Range of apartments.

ApartmentRange(start: String, end: String? = null)

Range of apartments.

Parameters

start

end

Properties

val start​

Beginning of the range/stored value. Currently, only numeric values are possible, while there are no apartments with suffixes in the data yet.

val end​

End of the range. If absent, the range consists of a single start value. Otherwise, it is an arithmetic progression from start to end in increments of 1.

Attribute​

Additional attribute. Example: { tag: "hotel_room_internet", name: "Free internet in rooms" }

Attribute(tag: String, value: String)

Additional attribute. Example: { tag: "hotel_room_internet", name: "Free internet in rooms" }

Parameters

tag

value

Properties

val tag​

Tag.

val value​

Value.

Attributes​

Interface for managing map object properties.

Only map objects have properties, but you can set default properties for the entire map, the style, and the source (see ISource for details).

Extends: ru.dgis.sdk.NativeObject
Methods
fun setAttributeValue(name: String, value: AttributeValue): Unit

Sets a property.

Parameters

name

Property name.

value

Value.

Returns
Unit
fun setAttributeValues(values: Map, attributesToRemove: List<String> = listOf()): Unit

Sets a property set.

Parameters

values

Set of the "name":"value" pairs for the added property.

attributesToRemove

List of names of properties to be removed.

Returns
Unit
fun removeAttribute(name: String): Unit

Deletes a property.

Parameters

name

Name of a property to delete.

Returns
Unit
fun getAttributeValue(name: String): AttributeValue

Gets a property.

Parameters

name

Name of a property to get.

Returns
AttributeValue
Properties

val attributeNames​

Gets a list of properties.

val changed​

Gets a channel that notifies about property changes.

AttributeValue​

Properties of map objects.

AttributeValue()
AttributeValue(boolean: Boolean)
Parameters

boolean

AttributeValue(number: Double)
Parameters

number

AttributeValue(integer: Long)
Parameters

integer

AttributeValue(string: String)
Parameters

string

AttributeValue(data: ByteArray)
Parameters

data

AttributeValue(array: List<AttributeValue>)
Parameters

array

AttributeValue(item: Map)
Parameters

item

Methods
fun match(
	empty: Function0<T>,
	boolean: Function1,
	number: Function1,
	integer: Function1,
	string: Function1,
	data: Function1,
	array: Function1,
	item: Function1
): T
Parameters

empty

boolean

number

integer

string

data

array

item

Returns
T
fun toString(): String
Returns
String
fun hashCode(): Int
Returns
Int
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
Properties

val isEmpty​

val isBoolean​

val asBoolean​

val isNumber​

val asNumber​

val isInteger​

val asInteger​

val isString​

val asString​

val isData​

val asData​

val isArray​

val asArray​

val isObject​

val asObject​

val value​

AudioSettings​

Class for managing the sound.

All methods can be called from any thread.

Extends: ru.dgis.sdk.NativeObject
Properties

var volume​

Sound volume level (0-100).

var mute​

Sound playing is disabled.

var audioFocusPolicy​

Behavior of other applications sounds with the requested focus.

AudioStreamReader​

Extends: ru.dgis.sdk.NativeObject
Methods
fun read(): List<Short>

Description of the callback function type that the audio driver calls to read audio data stream.

Returns
List<Short>

AuthorInfo​

Information about the author of the event or the photo.

AuthorInfo(type: AuthorType, name: String)

Information about the author of the event or the photo.

Parameters

type

name

Properties

val type​

Content author category.

val name​

String containing the name of the user who added the event or the photo.

  • Username if the author is an authorized user and has agreed to have their name displayed.
  • Empty string for an anonymous user or a user who has refused to have their name displayed.

AvailableCallback​

Extends: ru.dgis.sdk.NativeObject
Methods
fun setAvailable(available: Boolean): Unit

Availability of the audio device to the application.

Parameters

available

Indication of the audio device availability to the application.

Returns
Unit

BaseCamera​

Camera.

Sets the parameters for projecting the map onto the screen.

Extends: ru.dgis.sdk.NativeObject
Methods
fun clone(): BaseCamera

Creates a copy of the current camera.

Returns
BaseCamera
fun changePosition(positionChange: CameraPositionChange): Unit

Changes only a part of the camera position parameters.

The call interrupts flyover and gesture processing, and also resets following of changed parameters, and when changing coordinates, also resets following the style zoom level and direction.

Parameters

positionChange

Returns
Unit
Properties

val projection​

Projection.

Used to get a screen point from a map point and a map point from a screen point. Camera parameters are fixed at the time of the call.

val positionChannel​

Gets the current camera position.

var position​

Gets the current camera position.

val zoomRestrictionsChannel​

Gets current zoom level limits.

var zoomRestrictions​

Gets current zoom level limits.

val deviceDensityChannel​

Gets the DPI ratio to the device's base DPI.

val deviceDensity​

Gets the DPI ratio to the device's base DPI.

val sizeChannel​

Gets the size of the viewing area.

var size​

Gets the size of the viewing area.

val paddingChannel​

Gets current paddings from the screen edges.

var padding​

Gets current paddings from the screen edges.

val positionPointChannel​

Point on the screen to which the camera position is attached. The point is set based on paddings.

var positionPoint​

Point on the screen to which the camera position is attached. The point is set based on paddings.

val visibleArea​

Area of intersection of the camera visibility pyramid and the surface of the map.

val visibleRectChannel​

Rectangle indicating the visible area of the map.

val visibleRect​

Rectangle indicating the visible area of the map.

val maxTiltRestrictionChannel​

Gets the current function of the maximum camera tilt angle dependency on the style zoom level.

var maxTiltRestriction​

Gets the current function of the maximum camera tilt angle dependency on the style zoom level.

val viewportRestrictionChannel​

Gets the viewport restrictions.

var viewportRestriction​

Gets the viewport restrictions.

Bearing​

The angle between the directions of two objects or between the direction of the object and the north. The angle is measured clockwise. The range of values is 0°,360°.

Bearing(value: Double = 0.0)

The angle between the directions of two objects or between the direction of the object and the north. The angle is measured clockwise. The range of values is 0°,360°.

Parameters

value

Properties

val value​

BearingFollowController​

Controller following the map bearing.

Extends: ru.dgis.sdk.map.FollowController
BearingFollowController(
	bearingSource: BearingSource,
	animationDuration: Duration = Duration.ofMilliseconds(1000),
	valueThreshold: Bearing = Bearing(value = 1.0)
)

Creates a controller for following the map direction.

Parameters

bearingSource

Source of information about direction.

animationDuration

Non-negative duration of change in real direction.

valueThreshold

Non-negative threshold value of considered change in real direction.

BetterRouteInfo​

Information about an available alternative route.

BetterRouteInfo(trafficRoute: TrafficRoute, startPoint: RoutePoint)

Information about an available alternative route.

Parameters

trafficRoute

startPoint

Properties

val trafficRoute​

Alternative route.

val startPoint​

The point on the alternative route, from which the movement starts in case of switchingt to this route.

BetterRoutePromptControl​

Dialog prompting you to switch to a route with a lower expected arrival time.

Extends: ru.dgis.sdk.navigation.NavigationControl
BetterRoutePromptControl(
	context: Context,
	attrs: AttributeSet? = null,
	defStyle: Int = 0
)

Dialog prompting you to switch to a route with a lower expected arrival time.

Parameters

context

attrs

defStyle

Methods
fun attachToModel(model: Model): Unit
Parameters

model

Returns
Unit
Properties

val visibilityChannel​

BicycleBriefRouteInfo​

Basic information about the cycling route.

BicycleBriefRouteInfo(length: RouteDistance, landmark: String)

Basic information about the cycling route.

Parameters

length

landmark

Properties

val length​

Route length.

val landmark​

Landmark.

BicycleInstructionCrossroad​

Description of maneuvers when passing through an intersection or a pedestrian crossing.

BicycleInstructionCrossroad(landmark: BicycleInstructionCrossroadLandmark = BicycleInstructionCrossroadLandmark.NONE, maneuvers: List<BicycleInstructionCrossroadManeuver>)

Description of maneuvers when passing through an intersection or a pedestrian crossing.

Parameters

landmark

maneuvers

Properties

val landmark​

Landmark.

val maneuvers​

A chain of consecutive maneuvers.

BicycleInstructionCrossroadManeuver​

BicycleInstructionCrossroadManeuver(direction: BicycleInstructionCrossroadManeuverDirection = BicycleInstructionCrossroadManeuverDirection.STRAIGHT, turnAngle: Int = 0)
Parameters

direction

turnAngle

Properties

val direction​

Direction of movement.

val turnAngle​

Angle of rotation in degrees -180,180.

BicycleInstructionFinish​

End of the cycling part of the route.

BicycleInstructionFinish()

End of the cycling part of the route.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

BicycleInstructionStart​

Beginning of the cycling part of the route.

BicycleInstructionStart()

Beginning of the cycling part of the route.

Methods
fun toString(): String
Returns
String
fun equals(other: Any?): Boolean
Parameters

other

Returns
Boolean
fun hashCode(): Int
Returns
Int

BicycleRouteSearchOptions​

Bicycle route search options.

BicycleRouteSearchOptions(
	avoidCarRoads: Boolean = false,
	avoidStairways: Boolean = false,
	avoidUnderpassesAndOverpasses: Boolean = false,
	excludedAreas: List<ExcludedArea> = listOf()
)

Bicycle route search options.

Parameters

avoidCarRoads

avoidStairways

avoidUnderpassesAndOverpasses

excludedAreas

Properties

val avoidCarRoads​

Avoid highways.

val avoidStairways​

Avoid stairways.

val avoidUnderpassesAndOverpasses​

Avoid underground and elevated passages.

val excludedAreas​

Excluded areas (not more than 25).

BoolRouteLongAttribute​

A container that stores an extended route attribute. Each element is stored as a pair consisting of a point and an attribute element value. Attribute action starts at this point and ends at the next point, at which the next element's attribute action begins.

Extends: ru.dgis.sdk.NativeObject
Methods
fun entry(point: RoutePoint): BoolRouteLongEntry?

Element that the specified point falls into.

Parameters

point

Returns
BoolRouteLongEntry?
fun entries(begin: RoutePoint, end: RoutePoint): List<BoolRouteLongEntry>

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

Parameters

begin

end

Returns
List<BoolRouteLongEntry>
Properties

val size​

Amount of elements.

val isEmpty​

Elements are missing.

val first​

First element.

val last​

Last element.

val entries​

All elements.

BoolRouteLongEntry​

Extended route element - segment and value on it.

BoolRouteLongEntry(
	point: RoutePoint,
	length: RouteDistance,
	value: Boolean
<