RegionElement

public struct RegionElement : HorizonElement

HorizonElement that contains data about a region.

To receive such elements in the HorizonSnapshot, specify HorizonElementType.regionType in the HorizonOptions that you register with the HorizonEngine:

let horizonOptions = HorizonOptions(
    id: UUID(),
    elementTypes: [.regionType],
    ...
)

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
Type of the element. Used to filter elements by type.
Declaration
Swift

public let elementType: HorizonElementType
id
Identifier of this element.
Declaration
Swift

public let id: Int
pathID
Identifier of the HorizonPath to which this element belongs.
Declaration
Swift

public let pathID: Int
startOffset
Start offset on the HorizonPath.
Declaration
Swift

public let startOffset: Measurement<UnitLength>
endOffset
End offset on the HorizonPath.
Declaration
Swift

public let endOffset: Measurement<UnitLength>
country
Name of the country. Empty string if no country is assigned to the corresponding part of the path.
Declaration
Swift

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

public let subCountry: String