-
-
Notifications
You must be signed in to change notification settings - Fork 842
/
ShapeSource.tsx
406 lines (355 loc) · 10.9 KB
/
ShapeSource.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
import React from 'react';
import {
NativeMethods,
NativeModules,
NativeSyntheticEvent,
requireNativeComponent,
} from 'react-native';
import { getFilter } from '../utils/filterUtils';
import {
toJSONString,
cloneReactChildrenWithProps,
isFunction,
isAndroid,
} from '../utils';
import { copyPropertiesAsDeprecated } from '../utils/deprecation';
import { OnPressEvent } from '../types/OnPressEvent';
import AbstractSource from './AbstractSource';
import NativeBridgeComponent from './NativeBridgeComponent';
const MapboxGL = NativeModules.RNMBXModule;
export const NATIVE_MODULE_NAME = 'RNMBXShapeSource';
type OnPressEventDeprecated = OnPressEvent & {
nativeEvent?: OnPressEvent;
};
export type Props = {
/**
* A string that uniquely identifies the source.
*/
id: string;
/**
* The id refers to en existing source in the style. Does not create a new source.
*/
existing?: boolean;
/**
* An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle.
*/
url?: string;
/**
* The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature collection.
*/
shape?:
| GeoJSON.GeometryCollection
| GeoJSON.Feature
| GeoJSON.FeatureCollection
| GeoJSON.Geometry;
/**
* Enables clustering on the source for point shapes.
*/
cluster?: boolean;
/**
* Specifies the radius of each cluster if clustering is enabled.
* A value of 512 produces a radius equal to the width of a tile.
* The default value is 50.
*/
clusterRadius?: number;
/**
* Specifies the maximum zoom level at which to cluster points if clustering is enabled.
* Defaults to one zoom level less than the value of maxZoomLevel so that, at the maximum zoom level,
* the shapes are not clustered.
*/
clusterMaxZoomLevel?: number;
/**
* [`mapbox-gl` (v8) implementation only]
* Specifies custom properties on the generated clusters if clustering
* is enabled, aggregating values from clustered points.
*
* Has the form `{ "property_name": [operator, map_expression]}`, where
* `operator` is a custom reduce expression that references a special `["accumulated"]` value -
* it accumulates the property value from clusters/points the cluster contains
* `map_expression` produces the value of a single point
*
* Example: `{ "resultingSum": [["+", ["accumulated"], ["get", "resultingSum"]], ["get", "scalerank"]] }`
*
*/
clusterProperties?: object;
/**
* Specifies the maximum zoom level at which to create vector tiles.
* A greater value produces greater detail at high zoom levels.
* The default value is 18.
*/
maxZoomLevel?: number;
/**
* Specifies the size of the tile buffer on each side.
* A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself.
* Larger values produce fewer rendering artifacts near tile edges and slower performance.
* The default value is 128.
*/
buffer?: number;
/**
* Specifies the Douglas-Peucker simplification tolerance.
* A greater value produces simpler geometries and improves performance.
* The default value is 0.375.
*/
tolerance?: number;
/**
* Whether to calculate line distance metrics.
* This is required for line layers that specify lineGradient values.
* The default value is false.
*/
lineMetrics?: boolean;
/**
* Source press listener, gets called when a user presses one of the children layers only
* if that layer has a higher z-index than another source layers
*
* @param {Object} event
* @param {Object[]} event.features - the geojson features that have hit by the press (might be multiple)
* @param {Object} event.coordinates - the coordinates of the click
* @param {Object} event.point - the point of the click
* @return void
*/
onPress?: (event: OnPressEvent) => void;
/**
* Overrides the default touch hitbox(44x44 pixels) for the source layers
*/
hitbox?: {
/**
* `width` of hitbox
*/
width: number;
/**
* `height` of hitbox
*/
height: number;
};
children?: React.ReactElement | React.ReactElement[];
};
/**
* ShapeSource is a map content source that supplies vector shapes to be shown on the map.
* The shape may be an url or a GeoJSON object
*/
export class ShapeSource extends NativeBridgeComponent(
AbstractSource<Props, NativeProps>,
NATIVE_MODULE_NAME,
) {
static NATIVE_ASSETS_KEY = 'assets';
static defaultProps = {
id: MapboxGL.StyleSource.DefaultSourceID,
};
constructor(props: Props) {
super(props);
}
_setNativeRef(
nativeRef: React.Component<NativeProps> & Readonly<NativeMethods>,
) {
this.setNativeRef(nativeRef);
super._runPendingNativeCommands(nativeRef);
}
/**
* Returns all features from the source that match the query parameters whether the feature is currently
* rendered on the map.
*
* @example
* shapeSource.features()
*
* @param {Array=} filter - an optional filter statement to filter the returned Features.
* @return {FeatureCollection}
*/
async features(filter: Array<string> = []) {
const res: { data: string } = await this._runNativeCommand(
'features',
this._nativeRef,
getFilter(filter),
);
if (isAndroid()) {
return JSON.parse(res.data);
}
return res.data;
}
/**
* Returns the zoom needed to expand the cluster.
*
* @example
* const zoom = await shapeSource.getClusterExpansionZoom(clusterId);
*
* @param {Feature} feature - The feature cluster to expand.
* @return {number}
*/
async getClusterExpansionZoom(
feature: string | GeoJSON.Feature,
): Promise<number> {
if (typeof feature === 'number') {
console.warn(
'Using cluster_id is deprecated and will be removed from the future releases. Please use cluster as an argument instead.',
);
const res: { data: number } = await this._runNativeCommand(
'getClusterExpansionZoomById',
this._nativeRef,
[feature],
);
return res.data;
}
const res: { data: number } = await this._runNativeCommand(
'getClusterExpansionZoom',
this._nativeRef,
[JSON.stringify(feature)],
);
return res.data;
}
/**
* Returns the FeatureCollection from the cluster.
*
* @example
* const collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);
*
* @param {GeoJSON.Feature} feature - The feature cluster to expand.
* @param {number} limit - The number of points to return.
* @param {number} offset - The amount of points to skip (for pagination).
* @return {FeatureCollection}
*/
async getClusterLeaves(
feature: number | GeoJSON.Feature,
limit: number,
offset: number,
) {
if (typeof feature === 'number') {
console.warn(
'Using cluster_id is deprecated and will be removed from the future releases. Please use cluster as an argument instead.',
);
const res: { data: string } = await this._runNativeCommand(
'getClusterLeavesById',
this._nativeRef,
[feature, limit, offset],
);
if (isAndroid()) {
return JSON.parse(res.data);
}
return res.data;
}
const res: { data: string } = await this._runNativeCommand(
'getClusterLeaves',
this._nativeRef,
[JSON.stringify(feature), limit, offset],
);
if (isAndroid()) {
return JSON.parse(res.data);
}
return res.data;
}
/**
* Returns the FeatureCollection from the cluster (on the next zoom level).
*
* @example
* const collection = await shapeSource.getClusterChildren(clusterId);
*
* @param {GeoJSON.Feature} feature - The feature cluster to expand.
* @return {FeatureCollection}
*/
async getClusterChildren(feature: number | GeoJSON.Feature) {
if (typeof feature === 'number') {
console.warn(
'Using cluster_id is deprecated and will be removed from the future releases. Please use cluster as an argument instead.',
);
const res: { data: string } = await this._runNativeCommand(
'getClusterChildrenById',
this._nativeRef,
[feature],
);
if (isAndroid()) {
return JSON.parse(res.data);
}
return res.data;
}
const res: { data: string } = await this._runNativeCommand(
'getClusterChildren',
this._nativeRef,
[JSON.stringify(feature)],
);
if (isAndroid()) {
return JSON.parse(res.data);
}
return res.data;
}
setNativeProps(props: NativeProps) {
const shallowProps = Object.assign({}, props);
// Adds support for Animated
if (shallowProps.shape && typeof shallowProps.shape !== 'string') {
shallowProps.shape = JSON.stringify(shallowProps.shape);
}
super.setNativeProps(shallowProps);
}
_getShape() {
if (!this.props.shape) {
return;
}
return toJSONString(this.props.shape);
}
onPress(
event: NativeSyntheticEvent<{
payload: OnPressEvent;
}>,
) {
const {
nativeEvent: {
payload: { features, coordinates, point },
},
} = event;
let newEvent: OnPressEventDeprecated = {
features,
coordinates,
point,
};
newEvent = copyPropertiesAsDeprecated(
event as unknown as Record<string, unknown>,
newEvent,
(key) => {
console.warn(
`event.${key} is deprecated on ShapeSource#onPress, please use event.features`,
);
},
{
nativeEvent: (origNativeEvent: unknown) => ({
...(origNativeEvent as OnPressEvent),
payload: features[0],
}),
},
);
this.props.onPress?.(newEvent);
}
render() {
const props = {
id: this.props.id,
existing: this.props.existing,
url: this.props.url,
shape: this._getShape(),
hitbox: this.props.hitbox,
hasPressListener: isFunction(this.props.onPress),
onMapboxShapeSourcePress: this.onPress.bind(this),
cluster: this.props.cluster ? 1 : 0,
clusterRadius: this.props.clusterRadius,
clusterMaxZoomLevel: this.props.clusterMaxZoomLevel,
clusterProperties: this.props.clusterProperties,
maxZoomLevel: this.props.maxZoomLevel,
buffer: this.props.buffer,
tolerance: this.props.tolerance,
lineMetrics: this.props.lineMetrics,
onPress: undefined,
ref: (
nativeRef: React.Component<NativeProps> & Readonly<NativeMethods>,
) => this._setNativeRef(nativeRef),
onAndroidCallback: isAndroid() ? this._onAndroidCallback : undefined,
};
return (
<RNMBXShapeSource {...props}>
{cloneReactChildrenWithProps(this.props.children, {
sourceID: this.props.id,
})}
</RNMBXShapeSource>
);
}
}
type NativeProps = {
id: string;
shape?: string;
};
const RNMBXShapeSource =
requireNativeComponent<NativeProps>(NATIVE_MODULE_NAME);