VMVenueStyle

@objcMembers public class VMVenueStyle: NSObject

Class for styling a venue map

Since

1.1

Public Properties

  • Default style id

    Declaration

    Swift

    public static let DEFAULT_STYLE_ID = "style_default";

  • Style spec version

    Since

    1.2

    Declaration

    Swift

    public static let CURRENT_STYLE_SPEC_VERSION = VMVenueStyle.VERSION_1_1;

  • Since

    1.2

    Declaration

    Swift

    public static let VERSION_1_0: Float = 1.0

  • Since

    1.2

    Declaration

    Swift

    public static let VERSION_1_1: Float = 1.1

  • List of supported versions

    Since

    1.2

    Declaration

    Swift

    public static let SUPPORTED_STYLE_SPEC_VERSIONS = [VMVenueStyle.VERSION_1_0, VMVenueStyle.VERSION_1_1];
  • id

    Unique identifier for this style

    Declaration

    Swift

    public var id: String;

  • Common name for the style

    Declaration

    Swift

    public var name: String;

  • Spec version that this style adheres to

    Since

    1.2

    Declaration

    Swift

    public var version: Float;

  • Venue identifier that this style applies to

    Declaration

    Swift

    public var venueId: String;

  • wayfinding-specific style definition

    Declaration

    Swift

    public var wayfindingStyle: VMVenueWayfindingStyle?

  • custom map layer styles

    Since

    1.2

    Declaration

    Swift

    public var layerStyles: [VMVenueLayerStyle];

Initializers

  • Initializes a new style for the given venue with the given id

    Declaration

    Swift

    public init( id: String,  venueId: String)

    Parameters

    id

    the style id (should be unique per venue)
    venueId

    the venue id

  • Initializes a new style for the given venue with the given configuration

    Declaration

    Swift

    public convenience init( config cfgPath: URL,  venueId: String )

    Parameters

    cfgPath

    the absolute path to a map style config file
    venueId

    the venue id

  • Initializes a new style with the given configuration

    Since

    1.2

    Declaration

    Swift

    public convenience init(config cfgPath: URL )

    Parameters

    cfgPath

    the absolute path to the map style config file

Method Overrides

  • Description for the style

    Declaration

    Swift

    override public var description: String

Public Methods

  • Find a style layer from the config matching the id pattern

    Since

    1.2

    Declaration

    Swift

    public func findStyleLayerWithId(_ id: String ) -> VMVenueLayerStyle?

    Parameters

    id

    the id

    Return Value

    the matching style, if any

  • Find a style layer for the given building and map layer id

    Since

    1.2

    Declaration

    Swift

    public func findStyleLayerForBuilding(_ building: VMMSBaseBuilding?, _ mapLayerId: String) -> VMVenueLayerStyle?

    Parameters

    building

    the building
    mapLayerId

    the layer id

    Return Value

    the matching layer style, or nil

  • Find a style layer for the given floor and map layer id

    Since

    1.2

    Declaration

    Swift

    public func findStyleLayerForFloor(_ floor: VMMSBaseFloor? , _ mapLayerId: String) -> VMVenueLayerStyle?

    Parameters

    floor

    the floor
    mapLayerId

    the layer id

    Return Value

    the matching layer style, or nil

  • Find venue style layer definition for matching building/floor combination

    Since

    1.2

    Declaration

    Swift

    public func findStyleLayerForBuildingAndFloor(_ building: VMMSBaseBuilding?,_ floor: VMMSBaseFloor?, _ mapLayerId: String) -> VMVenueLayerStyle?

    Parameters

    building

    the building
    floor

    the floor
    mapLayerId

    the corresponding map style layer

    Return Value

    the matching layer style, or nil