TomTom SDK for iOS PrefetchingConfiguration

PrefetchingConfiguration

public struct PrefetchingConfiguration

Configuration parameters for prefetching navigation map data. It defines area around the current position or around the active route for which navigation map data is prefetched and kept available in NavigationTileStore.

  • Creates an instance of PrefetchingConfiguration.

    Declaration

    Swift

    public init(
    prefetchedAreaRadius: Measurement<UnitLength> = Defaults.prefetchedAreaRadius,
    shouldRequestLaneTiles: Bool = false

)

    Parameters

    prefetchedAreaRadius

    Radius around the current position defining the minimum area for which navigation map data is prefetched and kept available. The actual area fetched can be greater than the requested radius. The larger the radius, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost. The value must be non-negative integer. The parameter defaults to Defaults.prefetchedAreaRadius meters.
    shouldRequestLaneTiles

    The setting enabling access to lane tiles in the navigation tiles. When value is true lane level visualization can display the road network with enhanced lane geometry. The parameter defaults to false.

  • Creates an instance of PrefetchingConfiguration.

    Important

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

    Declaration

    Swift

    public init(
    prefetchedAreaAlongRoute: AreaAlongRoute? = Defaults.areaAlongRoute,
    prefetchedAreaRadius: Measurement<UnitLength> = Defaults.prefetchedAreaRadius,
    shouldRequestLaneTiles: Bool = false

)

    Parameters

    prefetchedAreaAlongRoute

    Area along the active route to prefetch navigation map data and keep it available. If the parameter is omitted, the default area along the active route will be used. If the parameter is set to nil, no navigation map data along the active route will be prefetched. The larger the area, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost. This parameter has effect only with useNDSLive feature toggle enabled. The parameter defaults to Defaults.areaAlongRoute.
    prefetchedAreaRadius

    Radius around the current position defining the minimum area for which navigation map data is prefetched and kept available. The actual area fetched can be greater than the requested radius. The larger the radius, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost. The value must be non-negative integer. The parameter defaults to Defaults.prefetchedAreaRadius meters.
    shouldRequestLaneTiles

    The setting enabling access to lane tiles in the navigation tiles. When value is true lane level visualization can display the road network with enhanced lane geometry. The parameter defaults to false.

  • Default value constants for PrefetchingConfiguration parameters.

    See more

    Declaration

    Swift

    public enum Defaults

  • Area along the active route to prefetch navigation map data and keep it available. If the parameter is omitted, the default area along the active route will be used. If the parameter is set to nil, no navigation map data along the active route will be prefetched. The larger the area, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost.

    Warning

    This parameter has effect only with useNDSLive feature toggle enabled.

    The parameter defaults to Defaults.areaAlongRoute.

    Important

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

    Declaration

    Swift

    public var prefetchedAreaAlongRoute: AreaAlongRoute?

  • Radius around the current position defining the minimum area for which navigation map data is prefetched and kept available. The actual area fetched can be greater than the requested radius. The larger the radius, the more robust the system is to temporary unavailability of the map data source, but at a greater memory cost. The network bandwidth cost will also be greater if the map data source is online. The value must be non-negative integer.

    The parameter defaults to Defaults.prefetchedAreaRadius.

    Declaration

    Swift

    public var prefetchedAreaRadius: Measurement<UnitLength>

  • The setting enabling access to lane tiles in the navigation tiles. When set to true, lane level visualization can display the road network with enhanced lane geometry.

    Warning

    enabling lane tiles will result in increased data consumption.

    The parameter defaults to false.

    Declaration

    Swift

    public var shouldRequestLaneTiles: Bool