MSFVectorTileSearchService

Objective-C


@interface MSFVectorTileSearchService : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

Swift

class MSFVectorTileSearchService : NSObject

A search service for finding features from the specified vector tile data source. Depending on the datasource, searching may perform network requests and must be executed in non-UI background thread.

  • Constructs a VectorTileSearchService for the given vector data source and vector tile decoder.

    Declaration

    Objective-C

    - (id)initWithDataSource:(MSFTileDataSource *)dataSource
             tileDecoder:(MSFVectorTileDecoder *)tileDecoder;

    Swift

    init!(dataSource: MSFTileDataSource!, tileDecoder: MSFVectorTileDecoder!)

    Parameters

    dataSource

    The vector data source to search from.
    tileDecoder

    The vector tile decoder to use for decoding the tiles.

  • Returns the tile data source of the search service.

    Declaration

    Objective-C

    - (MSFTileDataSource *)getDataSource;

    Swift

    func getDataSource() -> MSFTileDataSource!

    Return Value

    The tile data source of the search service.

  • Returns the projection the results are expressed in, which is the data source’s.

    Declaration

    Objective-C

    - (MSFProjection *)getProjection;

    Swift

    func getProjection() -> MSFProjection!

    Return Value

    The projection of the found features’ positions.

  • Returns the tile decoder used by the search service.

    Declaration

    Objective-C

    - (MSFVectorTileDecoder *)getTileDecoder;

    Swift

    func getTileDecoder() -> MSFVectorTileDecoder!

    Return Value

    The tile decoder used by the search service.

  • Returns the minimum zoom level of vector tiles used. By default the minimum zoom level is specified by data source and is usually 0.

    Declaration

    Objective-C

    - (int)getMinZoom;

    Swift

    func getMinZoom() -> Int32

    Return Value

    The minimum zoom level of vector tiles used.

  • Sets the minimum zoom level of vector tiles used.

    Declaration

    Objective-C

    - (void)setMinZoom:(int)minZoom;

    Swift

    func setMinZoom(_ minZoom: Int32)

    Parameters

    minZoom

    The new minimum zoom level.

  • Returns the maximum zoom level of vector tiles used. By default the maximum zoom level is specified by data source.

    Declaration

    Objective-C

    - (int)getMaxZoom;

    Swift

    func getMaxZoom() -> Int32

    Return Value

    The maximum zoom level of vector tiles used.

  • Sets the maximum zoom level of vector tiles used.

    Declaration

    Objective-C

    - (void)setMaxZoom:(int)maxZoom;

    Swift

    func setMaxZoom(_ maxZoom: Int32)

    Parameters

    maxZoom

    The new maximum zoom level.

  • Returns the maximum number of results the search service returns.

    Declaration

    Objective-C

    - (int)getMaxResults;

    Swift

    func getMaxResults() -> Int32

    Return Value

    The maximum number of results the search service returns.

  • Sets the maximum number of results the search service returns. The default number of results is 1000.

    Declaration

    Objective-C

    - (void)setMaxResults:(int)maxResults;

    Swift

    func setMaxResults(_ maxResults: Int32)

    Parameters

    maxResults

    The new maximum number of results the geocoding service returns.

  • Returns wether result features are sorted by distance

    Declaration

    Objective-C

    - (BOOL)getSortByDistance;

    Swift

    func getSortByDistance() -> Bool

    Return Value

    wether result features are sorted by distance

  • Sets wether to sort result features by distance

    Declaration

    Objective-C

    - (void)setSortByDistance:(BOOL)sortByDistance;

    Swift

    func setSortByDistance(_ sortByDistance: Bool)

    Parameters

    sortByDistance

    wether to sort result features by distance

  • Returns wether to prevent duplicate elements

    Declaration

    Objective-C

    - (BOOL)getPreventDuplicates;

    Swift

    func getPreventDuplicates() -> Bool

    Return Value

    wether to prevent duplicate elements

  • Sets wether to prevent duplicate elements (present in different tiles)

    Declaration

    Objective-C

    - (void)setPreventDuplicates:(BOOL)preventDuplicates;

    Swift

    func setPreventDuplicates(_ preventDuplicates: Bool)

    Parameters

    preventDuplicates

    wether to prevent duplicate elements

  • Returns the layers to filter while decoding tiles.

    Declaration

    Objective-C

    - (MSFStringVector *)getLayers;

    Swift

    func getLayers() -> MSFStringVector!

    Return Value

    The list of layers.

  • Sets the layers to filter.

    Declaration

    Objective-C

    - (void)setLayers:(MSFStringVector *)layers;

    Swift

    func setLayers(_ layers: MSFStringVector!)

  • Searches for the features specified by search request from the vector tiles bound to the service. The zoom level range used for searching is specified using minZoom/maxZoom attributes of the search service. Depending on the data source, this method may perform slow IO operations and may need to be run in background thread.

    Declaration

    Objective-C

    - (MSFVectorTileFeatureCollection *)findFeatures:(MSFSearchRequest *)request;

    Swift

    func findFeatures(_ request: MSFSearchRequest!) -> MSFVectorTileFeatureCollection!

    Parameters

    request

    The search request containing search filters.

    Return Value

    The resulting feature collection containing features matching the request.

  • Searches for the features specified by search request from the vector tiles bound to the service. The zoom level range used for searching is specified using minZoom/maxZoom attributes of the search service. Depending on the data source, this method may perform slow IO operations and may need to be run in background thread.

    Declaration

    Objective-C

    - (MSFVectorTileFeatureCollection *)
    findFeaturesSwigExplicitMSFVectorTileSearchService:
        (MSFSearchRequest *)request;

    Swift

    func findFeaturesSwigExplicitMSFVectorTileSearchService(_ request: MSFSearchRequest!) -> MSFVectorTileFeatureCollection!

    Parameters

    request

    The search request containing search filters.

    Return Value

    The resulting feature collection containing features matching the request.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()