GLMapStyleParser

Objective-C


@interface GLMapStyleParser : NSObject

Swift

class GLMapStyleParser : NSObject

GLMapStyleParser is calss to parse style and analyze result of parsing

  • Loads resource from path.

    Declaration

    Objective-C

    + (GLMapResource)loadResourceFromPath:(nonnull NSString *)path
                                 name:(nonnull NSString *)name;

    Swift

    class func loadResource(fromPath path: String, name: String) -> GLMapResource

    Parameters

    path

    Directory from where resource will be loaded
    name

    Name of resource

  • Initialize parser without resources

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    init()

  • Initialize parser with resources stored in bundle

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBundle:(nonnull NSBundle *)bundle;

    Swift

    init(bundle: Bundle)

    Parameters

    bundle

    Bundle object with Style.mapcss and images

  • Initialize parser with resources stored in paths First it tries to find resource in first path, then in second and so on.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPaths:(nonnull NSArray<NSString *> *)paths;

    Swift

    init(paths: [String])

    Parameters

    paths

    Paths where style will search for resources

  • Initialize parser with resource block

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBlock:(nonnull GLMapResourceBlock)resourceBlock;

    Swift

    init(block resourceBlock: @escaping GLMapResourceBlock)

    Parameters

    resourceBlock

    block that will provide resources

  • mask to clamp zoom levels

    Declaration

    Objective-C

    @property uint32_t clampZoomMask;

    Swift

    var clampZoomMask: UInt32 { get set }

  • All options for @if tests found while parsing.

    Declaration

    Objective-C

    @property (readonly) NSSet<NSString *> *_Nullable allOptions;

    Swift

    var allOptions: Set<String>? { get }

  • Error happened while parsing

    Declaration

    Objective-C

    @property (readonly) NSError *_Nullable error;

    Swift

    var error: Error? { get }

  • Sets global options. Will be available in all instances of parser.

    Declaration

    Objective-C

    + (void)setGlobalOptions:
    (nonnull NSDictionary<NSString *, NSString *> *)options;

    Swift

    class func setGlobalOptions(_ options: [String : String])

    Parameters

    options

    values for options

  • Sets style options

    Declaration

    Objective-C

    - (void)setOptions:(nonnull NSDictionary<NSString *, NSString *> *)options
      defaultValue:(BOOL)defaultValue;

    Swift

    func setOptions(_ options: [String : String], defaultValue: Bool)

    Parameters

    options

    values for options
    defaultValue

    value used for not set options

  • Parses next chunk of style

    Declaration

    Objective-C

    - (BOOL)parseNextBuffer:(nonnull NSData *)data;

    Swift

    func parseNextBuffer(_ data: Data) -> Bool

    Parameters

    data

    chunk of style to parse

  • Parses next chunk of style

    Declaration

    Objective-C

    - (BOOL)parseNextString:(nonnull NSString *)string;

    Swift

    func parseNextString(_ string: String) -> Bool

    Parameters

    string

    chunk of style to parse

  • Finishes parsing @returns returns result of parsing. If error happened returned value is nil. Check error for details

    Declaration

    Objective-C

    - (GLMapVectorCascadeStyle *_Nullable)finish;

    Swift

    func finish() -> GLMapVectorCascadeStyle?

  • Appends data from “Style.mapcss” in resources and finish parsing @returns returns result of parsing. If error happened returned value is nil. Check error for details

    Declaration

    Objective-C

    - (GLMapVectorCascadeStyle *_Nullable)parseFromResources;

    Swift

    func parseFromResources() -> GLMapVectorCascadeStyle?