VenueLevel

public class VenueLevel
extension VenueLevel: NativeBase
extension VenueLevel: Hashable

Represents one level of a building or a complex of buildings inside the VenueDrawing.

  • Undocumented

    Declaration

    Swift

    public typealias StringArray = [String]

  • Undocumented

    Declaration

    Swift

    public typealias GeometryArray = [VenueGeometry]

  • Undocumented

    Declaration

    Swift

    public typealias StringToPropertyMap = [String : Property]

  • Undocumented

    Declaration

    Swift

    public typealias StringToGeometryArrayMap = [String : VenueLevel.GeometryArray]

  • Undocumented

    Declaration

    Swift

    public typealias TopologyArray = [VenueTopology]

  • Undocumented

    Declaration

    Swift

    public typealias CrosswalkArray = [Crosswalk]

  • The id of the level.

    Declaration

    Swift

    public var identifier: String { get }

  • The Z index of the level, an order in the z direction (altitude). Z index 0 represents a ground level, negative values represent underground levels, positive values - levels above ground.

    Declaration

    Swift

    public var zIndex: Int32 { get }

  • The properties of the level.

    Declaration

    Swift

    public var properties: VenueLevel.StringToPropertyMap { get }

  • The name property of the level. If the ‘name’ property is missing in the properties, the string will be empty.

    Declaration

    Swift

    public var name: String { get }

  • The short name of the level.

    Declaration

    Swift

    public var shortName: String { get }

  • True if this is the main level and false otherwise.

    Declaration

    Swift

    public var isIsMainLevel: Bool { get }

  • The parent drawing of the level.

    Declaration

    Swift

    public var drawing: VenueDrawing { get }

  • The list of geometries of the level.

    Declaration

    Swift

    public var geometries: VenueLevel.GeometryArray { get }

  • The drawing ID of level.

    Declaration

    Swift

    public var drawingID: String { get }

  • The geographic coordinates of the center of the level.

    Declaration

    Swift

    public var center: GeoCoordinates { get }

  • The GeoBox of the bounding area.

    Declaration

    Swift

    public var boundingBox: GeoBox { get }

  • The geometries ordered by the name in an ascending order.

    Declaration

    Swift

    public var geometriesByName: VenueLevel.GeometryArray { get }

  • The map from the icon names to the geometries in the drawing.

    Declaration

    Swift

    public var geometriesByIconNames: VenueLevel.StringToGeometryArrayMap { get }

  • The list of topologies of the level.

    Declaration

    Swift

    public var topologies: VenueLevel.TopologyArray { get }

  • The list of crosswalks of the level.

    Declaration

    Swift

    public var crosswalks: VenueLevel.CrosswalkArray { get }

  • Gets a geometry by coordinates.

    Declaration

    Swift

    public func getGeometryByCoordinates(coordinates: GeoCoordinates) -> VenueGeometry?

    Parameters

    coordinates

    The coordinates inside the searching geometry.

    Return Value

    The geometry covering the coordinates or nil.

  • Gets geometries by coordinates.

    Declaration

    Swift

    public func getGeometriesByCoordinates(coordinates: GeoCoordinates) -> VenueLevel.GeometryArray

    Parameters

    coordinates

    The coordinates inside the searching geometries.

    Return Value

    The list of geometries covering the coordinate or an empty list.

  • Gets a geometry by an id.

    Declaration

    Swift

    public func getGeometryById(geometryId: String) -> VenueGeometry?

    Parameters

    geometryId

    The id of the geometry.

    Return Value

    The geometry with the given id or nil.

  • Gets a geometry by the VenueGeometry.InternalAddress.

    Declaration

    Swift

    public func getGeometryByAddress(geometryAddress: String) -> VenueGeometry?

    Parameters

    geometryAddress

    The internal address as a String.

    Return Value

    The geometry with the given address or nil.

  • Gets the filtered geometries in an ascending order.

    Declaration

    Swift

    public func filterGeometry(filter: String, filterType: VenueGeometryFilterType) -> VenueLevel.GeometryArray

    Parameters

    filter

    The filter string.
    filterType

    The filter type.

    Return Value

    The list of the filtered geometries or an empty list.

  • Gets a topology by coordinates.

    Declaration

    Swift

    public func getTopologyByCoordinates(coordinates: GeoCoordinates) -> VenueTopology?

    Parameters

    coordinates

    The coordinates inside the searching topology.

    Return Value

    The topology covering the coordinates or nil.

  • Gets a crosswalk by coordinates.

    Declaration

    Swift

    public func getCrosswalkByCoordinates(coordinates: GeoCoordinates) -> Crosswalk?

    Parameters

    coordinates

    The coordinates inside the searching crosswalk.

    Return Value

    The crosswalk covering the coordinates or nil.