TileRegionLoadOptions

extension TileRegionLoadOptions


                    
                    
                    build(geometry:descriptors:metadata:acceptExpired:networkRestriction:averageBytesPerSecond:)

Builds a TileRegionLoadOptions, required for TileStore.loadTileRegion(forId:loadOptions:)

averageBytesPerSecond is not a strict bandwidth limit, but only limits the average download speed. tile regions may be temporarily downloaded with higher speed, then pause downloading until the rolling average has dropped below this value.

Declaration

Swift

public static func build(
    geometry: Geometry?,
    descriptors: [TilesetDescriptor]?,
    metadata: Any? = nil,
    acceptExpired: Bool = false,
    networkRestriction: NetworkRestriction = .none,
    averageBytesPerSecond: Int? = nil
) -> TileRegionLoadOptions?

Parameters

`geometry`	The tile region’s associated geometry (optional).
`descriptors`	The tile region’s tileset descriptors.
`metadata`	A custom JSON value to be associated with this tile region.
`acceptExpired`	Accepts expired data when loading tiles.
`networkRestriction`	Restrict the tile region load request to the specified network types. If none of the specified network types is available, the load request fails with an error.
`averageBytesPerSecond`	Limits the download speed of the tile region.

Return Value

Describes the tile region load option values. If metadata is not a valid JSON object, then this initializer returns nil.