Region

public struct Region : HorizonElement

Describes a region on the horizon element.

This class holds a horizon element with information regarding region. It contains information regarding country and subcountry name. Subcountry name can contain either state, province or region name.

To obtain Region horizon elements, the integrator must create an instance of HorizonEngine, register HorizonOptions including elementTypes containing HorizonElementType .regionType with a call to HorizonEngine .registerHorizonOptions, and request a HorizonResult using the previously registered HorizonOptions with a call to HorizonEngine .generateHorizon.

Important

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

Lifecycle


                    
                    
                    init(id:pathID:startOffset:endOffset:country:subCountry:)

Initializes instance of Region.

Declaration

Swift

public init(
    id: Int,
    pathID: Int,
    startOffset: Measurement<UnitLength>,
    endOffset: Measurement<UnitLength>,
    country: String,
    subCountry: String
)

Public


                    
                    
                    elementType

Declaration

Swift

public let elementType: HorizonElementType

id
Declaration
Swift

public let id: Int
pathID
Declaration
Swift

public let pathID: Int


                    
                    
                    startOffset

Declaration

Swift

public let startOffset: Measurement<UnitLength>


                    
                    
                    endOffset

Declaration

Swift

public let endOffset: Measurement<UnitLength>

country
Country name. Empty string if no country is assigned to the part of the path.
Declaration
Swift

public let country: String
subCountry
State/province/region name. Empty string if no sub-country is assigned to the part of the path.
Declaration
Swift

public let subCountry: String