Structures

The following structures are available globally.

ConnectorDetails

VoltageRange

  • Specifies the minimum (inclusive) and maximum (exclusive) voltage values. The lower bound value should be a non-negative number (positive or zero). The upper bound value should be greater than the lower bound, or if set to zero, it will be treated as infinity. If not specified, a range of [0, infinity] is assumed.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct VoltageRange : Equatable, Hashable

GeoJSON

  • Generic container for GeoJSON geometry types.

    GeoJSON is a geospatial data interchange format based on JavaScript Object Notation (JSON). It defines several types of JSON objects and the manner in which they are combined to represent data about geographic features, their properties, and their spatial extents. For more info on the GeoJSON format see the following document.

    See more

    Declaration

    Swift

    public struct GeoJSON<T>
    extension GeoJSON: Equatable where T: Equatable

Feature

  • The Feature structure encapsulates a GeoJSON Feature - a geospatial object with associated properties. GeoJSON supports the following geometry types: Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, and GeometryCollection. Features in GeoJSON contain a Geometry object and additional properties.

    See more

    Declaration

    Swift

    public struct Feature
    extension Feature: Equatable

GeoJSONPosition

  • Fundamental geometry construct. All other GeoJSON geometry types are built based on it.

    See more

    Declaration

    Swift

    public struct GeoJSONPosition
    extension GeoJSONPosition: Equatable

BoundingBox

  • The smallest rectangular area within which all the coordinates lie.

    See more

    Declaration

    Swift

    public struct BoundingBox : Equatable, Hashable

Geometry

  • The Geometry struct represents a single geometric entity according to the GeoJSON specification.

    See more

    Declaration

    Swift

    public struct Geometry
    extension Geometry: Equatable

GeometryCollection

  • The GeometryCollection struct represents a collection of Geometry objects as defined by the GeoJSON specification. It provides a way to group multiple geometries together, regardless of their types.

    See more

    Declaration

    Swift

    public struct GeometryCollection
    extension GeometryCollection: Equatable

GeometryData

  • GeoJSON represented by GeometryData.

    See more

    Declaration

    Swift

    public struct GeometryData

Address

  • A collection of information that describes geographical location

    See more

    Declaration

    Swift

    public struct Address : Equatable
  • Information on how much to charge at a charging station.

    See more

    Declaration

    Swift

    public struct ChargingInformation

FuelType

  • Defines fuel types supported in the fuzzy search.

    See more

    Declaration

    Swift

    public struct FuelType : Hashable
    extension FuelType: CustomDebugStringConvertible

OpeningHours

  • Defines the OpeningHours of a POI.

    See more

    Declaration

    Swift

    public struct OpeningHours

POI

  • POI

    Point of Interest information for a search result.

    See more

    Declaration

    Swift

    public struct POI

POIID

  • Defines the POI identifier (POIID) required to fetch POI details.

    See more

    Declaration

    Swift

    public struct POIID

ChargingPark

  • Contains information about an EV charging park.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct ChargingPark

Brand

  • Defines a POI brand.

    See more

    Declaration

    Swift

    public struct Brand : Hashable

POICategoryID

EntryPoint

  • A representation of an entry point for a POI.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct EntryPoint
    extension EntryPoint: Equatable

Place

  • Represents information about specific place.

    See more

    Declaration

    Swift

    public struct Place : Equatable
  • Extending standard structures like Measurement with properties like var meters is convenient:

    • it avoids extracting value without explicit conversion to a certain unit
    • it simplifies getting value from an optional Measurement But it is also risky because these extensions might conflict with extensions from other libraries or Apple. This decorator mitigates the risk of conflicts while providing a short, readable code. Typical use cases are:
    • extracting value from a value representing a unit of measure: let optionalDistanceInMeters = distance?.tt.meters
    • performing computations on values representing units of measure: cumulativeDistance += anotherDistance.tt
    • comparing values representing units of measure: if delay < .tt.seconds(5) {}
    • combining value extraction and typecast: let intValue = distance.tt.intValue(in: .meters)
    See more

    Declaration

    Swift

    public struct MeasurementDecorator<UnitType> where UnitType : Unit

NumberOfLanes

  • Total number of lanes on the road in both directions.

    See more

    Declaration

    Swift

    public struct NumberOfLanes : Equatable

RoadProperties

  • Provides information about the properties of the road at the current location.

    See more

    Declaration

    Swift

    public struct RoadProperties : Equatable

Cause

  • Indicates the cause of a traffic event.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Cause

TrafficEvent

  • Representation of a traffic event. Traffic events represent unusual situations on the road, like traffic congestion, accidents or road works.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct TrafficEvent

EquatableWrapper

  • Wrapper to provide equatable conformance to Apple objects inside of the SDK.

    See more

    Declaration

    Swift

    @propertyWrapper
    public struct EquatableWrapper<T> : Equatable

AltitudeChangeEfficiency

  • Specifies the ratio by which energy is converted for altitude changes.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct AltitudeChangeEfficiency : Equatable, Hashable

AltitudeChangeEnergy

  • Specifies the energy that is gained or lost by altitude changes.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct AltitudeChangeEnergy : Equatable, Hashable

ChargingConnector

  • Describes connector information of an electric engine.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct ChargingConnector : Equatable, Hashable

CombustionEngine

  • A combustion vehicle engine for route planning and consumption estimation.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct CombustionEngine

ElectricEngine

  • A electric vehicle engine for route planning and consumption estimation.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct ElectricEngine

Pedestrian

  • A pedestrian.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Pedestrian : Vehicle, InternalConformanceLocked

Bicycle

  • A vehicle of type bicycle.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Bicycle : Vehicle, InternalConformanceLocked

Car

  • Car

    A vehicle of type car.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Car : Vehicle, Motorized, InternalConformanceLocked

Motorcycle

  • A vehicle of type motorcycle.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Motorcycle : Vehicle, Motorized, InternalConformanceLocked

Van

  • Van

    A vehicle of type van.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Van : Vehicle, Motorized, CargoCapable, InternalConformanceLocked

Taxi

  • A vehicle of type taxi.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Taxi : Vehicle, Motorized, InternalConformanceLocked

Bus

  • Bus

    A vehicle of type bus.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Bus : Vehicle, Motorized, InternalConformanceLocked

Truck

  • A vehicle of type truck.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Truck : Vehicle, Motorized, CargoCapable, InternalConformanceLocked

VehicleDimensions

  • Describes dimensions of the vehicle.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct VehicleDimensions

VehicleModelID

  • Describes vehicle model identifier.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct VehicleModelID : Equatable

VelocityChangeEfficiency

  • Specifies the ratio by which energy is converted during velocity changes.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct VelocityChangeEfficiency : Equatable, Hashable