Map

Map.

Extends: Hashable

public static func == (lhs: Map, rhs: Map) -> 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 setFontIconSizeMultiplier(
    multiplier: Float
) throws

Sets the size multiplier for icons and fonts obtained from the application.
Through set_font_icon_size_multiplier, you can set the size multiplier for icons and fonts without having to change the system multiplier and thus without affecting the size of icons and fonts in other applications.

Parameters

multiplier

Float

public func resetFontIconSizeMultiplier()

Resets the size multiplier for icons.

public func addSource(
    source: Source
)

Adds a data source to the map.
Happens asynchronously. The method can be called from any thread, thread-safe.

Parameters

source

Source

public func removeSource(
    source: Source
)

Removes a data source from the map.
Happens asynchronously. The method can be called from any thread, thread-safe.

Parameters

source

Source

public func getRenderedObjects(
    centerPoint: ScreenPoint,
    radius: ScreenDistance = ScreenDistance(value: 1)
) -> Future<[RenderedObjectInfo]>

Gets the displayed map objects projected on a circle on the screen.
The list of objects is formed in the rendering order from late to early.

Parameters

centerPoint

ScreenPoint

Circle center.

radius

ScreenDistance

Circle radius.

Returns

RenderedObjectInfo<[]>

public func setNavigation(_ isOn: Bool)

Sets the navigation flag. Affects how the map uses styles for the navigator mode.

Parameters

isOn

Bool

Properties

var id

MapId

Identifier of the map instance, unique within the process.

var camera

Camera

Gets a camera.

var indoorManager

IndoorManager

Gets floor plan manager.

var dataLoadingStateChannel

StatefulChannel<MapDataLoadingState>

Notification of the status of data being loaded into the map.
When tracking a camera position, the map state is always MapDataLoadingState::Loading.

var dataLoadingState

MapDataLoadingState

Notification of the status of data being loaded into the map.
When tracking a camera position, the map state is always MapDataLoadingState::Loading.

var styleChannel

StatefulChannel<Style>

Gets the current map styles.

var style

Style

Gets the current map styles.

var fontIconSizeMultiplierChannel

StatefulChannel<Float>

Icon and font size multiplier obtained from the application.

var fontIconSizeMultiplier

Float

Icon and font size multiplier obtained from the application.

var sources

[Source]

Obtains map data sources.
Happens asynchronously. The method can be called from any thread, thread-safe.

var mapVisibilityStateChannel

StatefulChannel<MapVisibilityState>

var mapVisibilityState

MapVisibilityState

var attributes

Attributes

Gets attributes.
The following properties must be specified: “theme”=“day|night” “navigatorOn”=“true|false”

var interactiveChannel

StatefulChannel<Bool>

Interactivity of the map (a user can interact with the map). If interactivity is disabled, the map stops responding to input events obtained from the user. Also, the map controls (zooming in and moving to the current position) stop working. However, you can still work with the map via set_position/move. When switching to a non-interactive state, incomplete gestures are reset. By default, the map is interactive (interactive == true).
The function can be called from any thread.

var interactive

Bool