VMVenueStyle

@objcMembers
open class VMVenueStyle : NSObject

Class for styling a venue map

Since

1.1

Public Properties

DEFAULT_STYLE_ID
Default style id
Declaration
Swift

public static let DEFAULT_STYLE_ID: String
CURRENT_STYLE_SPEC_VERSION
Style spec version

Since
1.2
Declaration
Swift

public static let CURRENT_STYLE_SPEC_VERSION: Float
VERSION_1_0
Since
1.2
Declaration
Swift

public static let VERSION_1_0: Float
VERSION_1_1
Since
1.2
Declaration
Swift

public static let VERSION_1_1: Float
VERSION_1_2
Since
2.0
Declaration
Swift

public static let VERSION_1_2: Float
SUPPORTED_STYLE_SPEC_VERSIONS
List of supported versions

Since
2.0
Declaration
Swift

public static let SUPPORTED_STYLE_SPEC_VERSIONS: [Float]
id
Unique identifier for this style
Declaration
Swift

public var id: String
name
Common name for the style
Declaration
Swift

public var name: String
version
Spec version that this style adheres to

Since
1.2
Declaration
Swift

public var version: Float
venueId
Venue identifier that this style applies to
Declaration
Swift

public var venueId: String
layerStyles
custom map layer styles

Since
1.2
Declaration
Swift

public var layerStyles: [VMVenueLayerStyle]

Initializers


                    
                    
                    init(id:venueId:)

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


                    
                    
                    init(config:venueId:)

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


                    
                    
                    init(config:)

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

Public Methods


                    
                    
                    findStyleLayerWithId(_:)

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


                    
                    
                    findStyleLayerForBuilding(_:_:)

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


                    
                    
                    findStyleLayerForFloor(_:_:)

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


                    
                    
                    findStyleLayerForBuildingAndFloor(_:_:_:)

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