MSFMBVectorTileDecoder

Objective-C


@interface MSFMBVectorTileDecoder : MSFVectorTileDecoder

Swift

class MSFMBVectorTileDecoder : MSFVectorTileDecoder

Decoder for vector tiles in MapBox format.

  • Constructs a decoder for MapBox vector tiles based on specified compiled style set.

    Declaration

    Objective-C

    - (id)initWithCompiledStyleSet:(MSFCompiledStyleSet *)compiledStyleSet;

    Swift

    init!(compiledStyleSet: MSFCompiledStyleSet!)

    Parameters

    compiledStyleSet

    The compiled style set for the tiles. @throws NSException If the decoder could not be created or there are issues with the style set.

  • Constructs a decoder for MapBox vector tiles based on specified CartoCSS style set.

    Declaration

    Objective-C

    - (id)initWithCartoCSSStyleSet:(MSFCartoCSSStyleSet *)cartoCSSStyleSet;

    Swift

    init!(cartoCSSStyleSet: MSFCartoCSSStyleSet!)

    Parameters

    cartoCSSStyleSet

    The CartoCSS style set for the tiles. @throws NSException If the decoder could not be created or there are issues with the style set.

  • Returns the current compiled style set used by the decoder. If decoder uses non-compiled style set, null is returned.

    Declaration

    Objective-C

    - (MSFCompiledStyleSet *)getCompiledStyleSet;

    Swift

    func getCompiledStyleSet() -> MSFCompiledStyleSet!

    Return Value

    The current style set.

  • Sets the current compiled style set used by the decoder.

    Declaration

    Objective-C

    - (void)setCompiledStyleSet:(MSFCompiledStyleSet *)styleSet;

    Swift

    func setCompiledStyleSet(_ styleSet: MSFCompiledStyleSet!)

    Parameters

    styleSet

    The new style set to use. @throws NSException If the decoder could not be updated or there are issues with the style set.

  • Returns the current CartoCSS style set used by the decoder. If decoder uses non-CartoCSS style set, null is returned.

    Declaration

    Objective-C

    - (MSFCartoCSSStyleSet *)getCartoCSSStyleSet;

    Swift

    func getCartoCSSStyleSet() -> MSFCartoCSSStyleSet!

    Return Value

    The current style set.

  • Sets the current CartoCSS style set used by the decoder.

    Declaration

    Objective-C

    - (void)setCartoCSSStyleSet:(MSFCartoCSSStyleSet *)styleSet;

    Swift

    func setCartoCSSStyleSet(_ styleSet: MSFCartoCSSStyleSet!)

    Parameters

    styleSet

    The new style set to use. @throws NSException If the decoder could not be updated or there are issues with the style set.

  • Returns the list of all available style parameters.

    Declaration

    Objective-C

    - (MSFStringVector *)getStyleParameters;

    Swift

    func getStyleParameters() -> MSFStringVector!

    Return Value

    The list of all available style parameters.

  • Returns the value of the specified style parameter. The style parameter must be declared in the current style.

    Declaration

    Objective-C

    - (NSString *)getStyleParameter:(NSString *)param;

    Swift

    func getStyleParameter(_ param: String!) -> String!

    Parameters

    param

    The parameter to return.

    Return Value

    The value of the parameter. If parameter does not exists, empty string is returned. @throws NSException If the style parameter does not exist.

  • Sets the value of the specified parameter. The style parameter must be declared in the current style.

    Declaration

    Objective-C

    - (BOOL)setStyleParameter:(NSString *)param value:(NSString *)value;

    Swift

    func setStyleParameter(_ param: String!, value: String!) -> Bool

    Parameters

    param

    The parameter to set.
    value

    The value for the parameter.

    Return Value

    True if the parameter was set. False if the style parameter does not exist or could not be set.

  • Sets the values of the specified parameters. The style parameters must be declared in the current style.

    Declaration

    Objective-C

    - (void)setStyleParameters:(MSFStringMap *)params;

    Swift

    func setStyleParameters(_ params: MSFStringMap!)

    Parameters

    params

    The getStyleParameters to set.

  • Sets the values of the specified parameters. The style parameters must be declared in the current style.

    Declaration

    Objective-C

    - (void)setJSONStyleParameters:(NSString *)params;

    Swift

    func setJSONStyleParameters(_ params: String!)

    Parameters

    params

    The getStyleParameters to set.

  • Returns the ordered list of style layer names as declared by the style (the project JSON “layers” array, or the Layer elements of a Mapnik XML style). This defines both the draw order and which layers exist. CompositeVectorTileLayer uses it to place external data sources in the layer order: a source whose name is not in this list has no slot in the style and is not drawn, so this is the way to check a style before wiring sources into it.

    Declaration

    Objective-C

    - (MSFStringVector *)getStyleLayerNames;

    Swift

    func getStyleLayerNames() -> MSFStringVector!

    Return Value

    The ordered style layer names.

  • Returns the value of feature id override flag. This is intended for cases when feature ids in tile are not globally unique.

    Declaration

    Objective-C

    - (BOOL)isFeatureIdOverride;

    Swift

    func isFeatureIdOverride() -> Bool

    Return Value

    The value of feature id override flag.

  • Sets the value of feature id override flag. This is intended for cases when feature ids in tile are not globally unique.

    Declaration

    Objective-C

    - (void)setFeatureIdOverride:(BOOL)idOverride;

    Swift

    func setFeatureIdOverride(_ idOverride: Bool)

    Parameters

    idOverride

    The value of the flag.

  • Returns the binary format the tiles are decoded as.

    Declaration

    Objective-C

    - (enum MSFTileFormat)getTileFormat;

    Swift

    func getTileFormat() -> MSFTileFormat

    Return Value

    The tile format. Default is MVT.

  • Sets the binary format the tiles are decoded as. The two formats are not distinguishable from the tile data, so the source has to say which it serves.

    Declaration

    Objective-C

    - (void)setTileFormat:(enum MSFTileFormat)format;

    Swift

    func setTileFormat(_ format: MSFTileFormat)

    Parameters

    format

    The tile format.

  • Maps a container’s declared format or encoding - an MBTiles or PMTiles metadata value, a TileJSON media type - onto a tile format. Matching is case-insensitive and by substring, because generators spell this differently (‘mvt’, ‘application/vnd.maplibre-vector-tile’). ‘pbf’ is inconclusive rather than MVT, since MapLibre’s tilesets keep format at ‘pbf’ and declare MLT through encoding instead.

    Declaration

    Objective-C

    + (enum MSFTileFormat)parseTileFormat:(NSString *)format;

    Swift

    class func parseTileFormat(_ format: String!) -> MSFTileFormat

    Parameters

    format

    The declared format or encoding string.

    Return Value

    The tile format, or TILE_FORMAT_AUTO when the string says nothing conclusive.

  • Undocumented

    Declaration

    Objective-C

    - (void)addFallbackFont:(MSFBinaryData *)fontData;

    Swift

    func addFallbackFont(_ fontData: MSFBinaryData!)

  • Undocumented

    Declaration

    Objective-C

    - (int)getMinZoom;

    Swift

    func getMinZoom() -> Int32

  • Undocumented

    Declaration

    Objective-C

    - (int)getMaxZoom;

    Swift

    func getMaxZoom() -> Int32

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()