feat: method querySourceFeatures (#16)

feat: add method querySourceFeatures

Author: KG3RK3N

README.md

@@ -689,6 +689,33 @@ Remove a layer added with addLayer() by id.
   mapbox.removeLayer( id );
 ```
 
+### queryRenderedFeatures
+https://docs.mapbox.com/mapbox-gl-js/api/map/#map#queryrenderedfeatures
+Returns an array of GeoJSON Feature objects representing visible features that satisfy the query parameters.
+
+```js
+mapbox
+  .queryRenderedFeatures({
+    point: {
+      lat: 52.3701494345567,
+      lng: 4.823684692382513,
+  	},
+    layers: ['circle-with-source-object'],
+    filter: ['==', ['get', 'querySample'], '2'],
+  })
+  .then((result) => console.log('query rendered features', result))
+```
+
+### querySourceFeatures
+https://docs.mapbox.com/mapbox-gl-js/api/map/#map#querysourcefeatures
+Returns an array of GeoJSON Feature objects representing features within the specified vector tile or GeoJSON source that satisfy the query parameters.
+
+```js
+mapbox
+  .querySourceFeatures('source_id', { filter: ['==', ['get', 'querySample'], '2'] })
+  .then((result) => console.log('query source features', result));
+```
+
 ### addLinePoint
 Dynamically add a point to a line.
 

demo/app/main-view-model.ts

@@ -481,6 +481,10 @@ export class HelloWorldModel extends Observable {
                                 filter: ['all', ['==', '$id', '2']],
                             })
                             .then((result) => console.log('query rendered features', JSON.stringify(result)));
+
+                        this.mapbox
+                            .querySourceFeatures('circle-with-source-object_source', { filter: ['==', ['get', 'querySample'], '2'] })
+                            .then((result) => console.log('query source features', JSON.stringify(result)));
                     }, 3000);
                 });
 

src/mapbox.android.ts

@@ -33,6 +33,7 @@ import {
     MapboxViewBase,
     OfflineRegion,
     QueryRenderedFeaturesOptions,
+    QuerySourceFeaturesOptions,
     SetCenterOptions,
     SetTiltOptions,
     SetViewportOptions,
@@ -1538,6 +1539,46 @@ export class Mapbox extends MapboxCommon implements MapboxApi {
         });
     }
 
+    querySourceFeatures(sourceId: string, options?: QuerySourceFeaturesOptions): Promise<Feature[]> {
+        return new Promise((resolve, reject) => {
+            try {
+                if (!options) {
+                    options = {};
+                }
+
+                const source = this._mapboxMapInstance.getStyle().getSource(sourceId);
+                if (!source) {
+                    throw new Error(`Source with id "${sourceId}" not found.`);
+                }
+
+                let features;
+                const queryFilter = options.filter ? FilterParser.parseJson(options.filter) : null;
+                if (source instanceof com.mapbox.mapboxsdk.style.sources.GeoJsonSource) {
+                    features = source.querySourceFeatures(queryFilter);
+                } else if (source instanceof com.mapbox.mapboxsdk.style.sources.VectorSource) {
+                    if (!options.sourceLayer) {
+                        throw new Error('The option "sourceLayer" is required for vector sources.');
+                    }
+                    features = source.querySourceFeatures([options.sourceLayer], queryFilter);
+                } else {
+                    throw new Error('Only sources from type "vector" or "geojson" are supported.');
+                }
+
+                const result = [];
+                for (let i = 0; i < features.size(); i++) {
+                    const feature: com.mapbox.geojson.Feature = features.get(i);
+                    result.push(JSON.parse(feature.toJson()));
+                }
+                resolve(result);
+            } catch (ex) {
+                if (Trace.isEnabled()) {
+                    CLog(CLogTypes.info, 'Error in mapbox.querySourceFeatures: ' + ex);
+                }
+                reject(ex);
+            }
+        });
+    }
+
     /**
      *
      * @deprecated

src/mapbox.common.ts

@@ -42,6 +42,13 @@ export interface QueryRenderedFeaturesOptions {
 
 // ------------------------------------------------------------
 
+export interface QuerySourceFeaturesOptions {
+    sourceLayer?: string;
+    filter?: any[];
+}
+
+// ------------------------------------------------------------
+
 export interface Feature {
     id?: any;
     type: string;
@@ -615,6 +622,8 @@ export interface MapboxApi {
 
     queryRenderedFeatures(options: QueryRenderedFeaturesOptions, nativeMap?: any): Promise<Feature[]>;
 
+    querySourceFeatures(sourceId: string, options?: QuerySourceFeaturesOptions, nativeMap?: any): Promise<Feature[]>;
+
     addPolygon(options: AddPolygonOptions, nativeMap?: any): Promise<any>;
 
     removePolygons(ids?: any[], nativeMap?: any): Promise<any>;
@@ -661,10 +670,10 @@ export interface MapboxApi {
 
     getLayers(nativeMap?: any): Promise<LayerCommon[]>;
 
-    getImage(imageId: string, nativeMap?: any): Promise<ImageSource>
+    getImage(imageId: string, nativeMap?: any): Promise<ImageSource>;
 
     addImage(imageId: string, image: string, nativeMap?: any): Promise<void>;
-    
+
     removeImage(imageId: string, nativeMap?: any): Promise<void>;
 }
 
@@ -739,7 +748,9 @@ export interface MapboxViewApi {
     removeMarkers(options?: any): Promise<any>;
 
     queryRenderedFeatures(options: QueryRenderedFeaturesOptions): Promise<Feature[]>;
-
+    
+    querySourceFeatures(sourceId: string, options?: QuerySourceFeaturesOptions): Promise<Feature[]>;
+    
     setOnMapClickListener(listener: (data: LatLng) => boolean): Promise<any>;
 
     setOnMapLongClickListener(listener: (data: LatLng) => boolean): Promise<any>;
@@ -957,6 +968,9 @@ export abstract class MapboxViewCommonBase extends ContentView implements Mapbox
     queryRenderedFeatures(options: QueryRenderedFeaturesOptions): Promise<Feature[]> {
         return this.mapbox.queryRenderedFeatures(options, this.getNativeMapView());
     }
+    querySourceFeatures(sourceId: string, options?: QuerySourceFeaturesOptions): Promise<Feature[]> {
+        return this.mapbox.querySourceFeatures(sourceId, options, this.getNativeMapView());
+    }
     addPolygon(options: AddPolygonOptions): Promise<any> {
         return this.mapbox.addPolygon(options, this.getNativeMapView());
     }

src/mapbox.ios.ts

@@ -13,6 +13,7 @@ import {
     DownloadOfflineRegionOptions,
     Feature,
     LatLng,
+    LayerCommon,
     ListOfflineRegionsOptions,
     MapStyle,
     MapboxApi,
@@ -22,6 +23,7 @@ import {
     MapboxViewBase,
     OfflineRegion,
     QueryRenderedFeaturesOptions,
+    QuerySourceFeaturesOptions,
     SetCenterOptions,
     SetTiltOptions,
     SetViewportOptions,
@@ -32,7 +34,6 @@ import {
     UserLocationCameraMode,
     Viewport,
     telemetryProperty,
-    LayerCommon,
 } from './mapbox.common';
 
 import { iOSNativeHelper } from '@nativescript/core/utils';
@@ -1422,6 +1423,49 @@ export class Mapbox extends MapboxCommon implements MapboxApi {
         });
     }
 
+    querySourceFeatures(sourceId: string, options?: QuerySourceFeaturesOptions, nativeMap?): Promise<Feature[]> {
+        return new Promise((resolve, reject) => {
+            try {
+                const theMap: MGLMapView = nativeMap || this._mapboxViewInstance;
+                if (!options) {
+                    options = {};
+                }
+
+                const source = theMap.style.sourceWithIdentifier(sourceId);
+                if (!source) {
+                    throw new Error(`Source with id "${sourceId}" not found.`);
+                }
+
+                let features;
+                const queryFilter = options.filter ? FilterParser.parseJson(options.filter) : null;
+                if (source instanceof MGLShapeSource) {
+                    features = source.featuresMatchingPredicate(queryFilter);
+                } else if (source instanceof MGLVectorTileSource) {
+                    if (!options.sourceLayer) {
+                        throw new Error('The option "sourceLayer" is required for vector sources.');
+                    }
+                    const sourceLayerIds = options.sourceLayer ? NSSet.setWithArray<string>(iOSNativeHelper.collections.jsArrayToNSArray([options.sourceLayer])) : null;
+                    features = source.featuresInSourceLayersWithIdentifiersPredicate(sourceLayerIds, queryFilter);
+                } else {
+                    throw new Error('Only sources from type "vector" or "geojson" are supported.');
+                }
+
+                const result = [];
+                for (let i = 0; i < features.count; i++) {
+                    const feature: MGLFeature = features.objectAtIndex(i);
+                    const featureJson = NSJSONSerialization.dataWithJSONObjectOptionsError(feature.geoJSONDictionary(), 0);
+                    result.push(JSON.parse(NSString.alloc().initWithDataEncoding(featureJson, NSUTF8StringEncoding) as any));
+                }
+                resolve(result);
+            } catch (ex) {
+                if (Trace.isEnabled()) {
+                    CLog(CLogTypes.info, 'Error in mapbox.querySourceFeatures: ' + ex);
+                }
+                reject(ex);
+            }
+        });
+    }
+
     /**
      * @deprecated
     */